Stream Members

Returns a list of all the current members of a stream (IM or chatroom).

List the current members of an existing stream. The stream can be of type IM, MIM, or ROOM

get

/v1/admin/stream/{id}/membership/list

Path parameters

idstringrequired

stream Id

Query parameters

skipinteger

Number of items to skip. Default is 0.

limitinteger

Maximum number of items to return. Default is 100 and not to exceed 1000.

Header parameters

sessionTokenstringrequired

Session authentication token.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'yourpodURL.symphony.com/pod/v1/admin/stream/{id}/membership/list' \
  --header 'sessionToken: text'

200

400

401

403

500

200

{
  "count": 3,
  "skip": 0,
  "limit": 32,
  "members": [
    {
      "isOwner": true,
      "isCreator": true,
      "joinDate": 1604494574047,
      "user": {
        "userId": 13537736917000,
        "email": "[e-mail]",
        "firstName": "John",
        "lastName": "Doe",
        "displayName": "John Doe",
        "company": "pod197",
        "companyId": 197,
        "isExternal": false
      }
    },
    {
      "isOwner": false,
      "isCreator": false,
      "joinDate": 1604494722469,
      "user": {
        "userId": 13606456393736,
        "email": "[e-mail]",
        "firstName": "Alice",
        "lastName": "Smith",
        "displayName": "Alice Smith",
        "company": "pod198",
        "companyId": 198,
        "isExternal": true
      }
    },
    {
      "isOwner": false,
      "isCreator": false,
      "joinDate": 1604494605272,
      "addedThroughGroups": [
        68719476744
      ],
      "user": {
        "userId": 13537736917001,
        "email": "[e-mail]",
        "displayName": "User Provisioning Bot",
        "company": "pod197",
        "companyId": 197,
        "isExternal": false
      }
    }
  ]
}

OK

Note: visit Overview for an overview of streams.

🚧 Required Permissions

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.

📘 External users

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

The isCreator field is relevant to IMs and chatrooms. For an IM, this is the person who initiated the first chat with the other user(s).

The isOwner field 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.

📘 Join Date

The joinDate field 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 joinDate reflects the most recent add date.

In the case of IMs and MIMs, the joinDate reflects the initiation date of the conversation. Every member will have the same joinDate.

📘 Note - Groups

Since 20.14, please note that the object addedThroughGroups has been added only for members added to the room via Groups.

See Groups for more information.