Note: visit Overview for an overview of streams.
To get the stream membership of any stream in your enterprise, you should call this endpoint with a Service User account with the User Provisioning role. The Service User does not need to be a member of the stream.
See Bot Permissions for a list of roles and associated privileges.
If you call this endpoint with a user that has the User Provisioning role, you will get the email address for both internal and external users.
Creation and Ownership
isCreatorfield is relevant to IMs, MIMs, and chatrooms. For an IM or MIM, this is the person who initiated the first chat with the other user(s).
isOwnerfield is relevant only to chatrooms. It denotes whether the user is an owner of the chatroom. While a room can only have one creator, it can have multiple owners.
joinDatefield is most relevant for chatrooms. It represents the time the user was added to the chatroom. If a user was added, removed, and then added back to the room, the
joinDatereflects the most recent add date.
In the case of IMs and MIMs, the
joinDatereflects the initiation date of the conversation. Every member will have the same
Note - Groups
Since 20.14, please note that the object
addedThroughGroupshas been added only for members added to the room via Groups.
See Groups for more information.