List user's channels
GET {{baseUrl}}/chat/users/:userId/channels?page_size=10&next_page_token=<string>
Lists a user's chat channels. For user-level apps, pass
the
me
value
instead of the
userId
parameter.
Zoom chat channels allow users to communicate via chat in private or public groups.
Scopes:
chat_channel:read
or
chat_channel:read:admin
Rate Limit Label
:
Medium
Note: This API supports both user-managed apps and account-level apps. However, in an account-level OAuth app , to list channels of another user in the same Zoom account, the user calling this API must have a role that has the View or Edit permission for the Chat channels feature.
Request Params
| Key | Datatype | Required | Description |
| page_size | number | | The number of records returned from 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
{"channels":[{"properties":{"channel_settings":{"add_member_permissions":2,"new_members_can_see_previous_messages_files":"\u003cboolean\u003e","posting_permissions":2,"mention_all_permissions":2,"allow_to_add_external_users":0},"id":"\u003cstring\u003e","jid":"\u003cstring\u003e","name":"\u003cstring\u003e","type":3,"channel_url":"\u003cstring\u003e"}},{"properties":{"channel_settings":{"add_member_permissions":2,"new_members_can_see_previous_messages_files":"\u003cboolean\u003e","posting_permissions":2,"mention_all_permissions":1,"allow_to_add_external_users":0},"id":"\u003cstring\u003e","jid":"\u003cstring\u003e","name":"\u003cstring\u003e","type":5,"channel_url":"\u003cstring\u003e"}}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","total_records":"\u003cinteger\u003e"}