Skip to main content
GET
Query Channel Users

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

channelId
string
required

Channel ID to query users from

Required string length: 1 - 900

Query Parameters

role
string[]

Role to filter

Required array length: 1 - 20 elements
Required string length: 1 - 900
sortBy
enum<string>
default:lastCreated

Sort channel users by createdAt or updatedAt, default is lastCreated

Available options:
lastCreated,
firstCreated
memberships
enum<string>[]

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

Required array length: 1 - 3 elements
Available options:
muted,
banned,
member
options[limit]
integer
default:10

Number of results per page (1-100)

Required range: 1 <= x <= 100
options[token]
string

Pagination token for getting next/previous pages

Maximum string length: 1000

Keyword to search for in user information such as displayName, profileHandle, and userId. The search is case-insensitive and supports partial matches.

Maximum string length: 10000
searchBy
enum<string>[]

Fields to search channel users for the keyword (up to 3 fields can be specified)
displayName - search by display name
profileHandle - search by profile handle
userId - search by user id
Default is all three fields

Maximum array length: 3
Available options:
displayName,
profileHandle,
userId
isDeleted
boolean

filter deleted members if isDeleted is null, will return both deleted and non-deleted members

Response

Channels Information

channels
object[]
channelUsers
object[]
users
object[]
files
object[]
paging
object