List channel members
GET {{baseUrl}}/chat/users/:userId/channels/:channelId/members?page_size=30&next_page_token=<string>
Lists all members of a channel. For user-level apps, pass the me
value instead of the userId
parameter.
Scopes: chat_channel:read:admin
Rate Limit Label: Medium
Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the View or Edit permission for Chat Channels.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page_size | number | The number of records returned with a single API call. | |
next_page_token | string | The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"members":[{"email":"\u003cemail\u003e","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","member_id":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","role":"member","is_external":"\u003cboolean\u003e"},{"email":"\u003cemail\u003e","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","member_id":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","role":"owner","is_external":"\u003cboolean\u003e"}],"next_page_token":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e"}