Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Channel ID to query users from
1 - 900
Query Parameters
Role to filter
1 - 20
elementsSort channel users by createdAt or updatedAt, default is lastCreated
lastCreated
, firstCreated
Member type to filter - member type: User is member of channel - banned type: User is banned member of channel - muted type: User is member of channel but isMuted is true
1 - 3
elementsNumber of results per page (1-100)
1 <= x <= 100
Pagination token for getting next/previous pages
1000
Keyword to search for in user information such as displayName, profileHandle, and userId. The search is case-insensitive and supports partial matches.
10000
Fields to search channel users for the keyword (up to 3 fields can be specified) <br>
displayName
- search by display name <br>
profileHandle
- search by profile handle <br>
userId
- search by user id <br>
Default is all three fields
3
filter deleted members if isDeleted is null, will return both deleted and non-deleted members