SendbirdSendbird Chat Platform server-side API v3
GET/v3/users
List users
Retrieves a paginated list of users in your Sendbird application. Combine various query parameters to customize the filter scope and shape the returned user list.
Manage users, group channels, open channels, messages, metadata, moderation, bots, and announcements through the official Sendbird Chat Platform API v3. The complete boundary is the 83 REST endpoints reconstructed from a pinned official generated SDK revision; client realtime protocols and Chat SDKs are not part of this collection. Application data is the caller's private content, so Pontx does not proxy, cache, or aggregate it and callers use the local SDK/CLI directly.
Request
- operationId
listUsers- Server
https://api-{app_id}.sendbird.com- Authentication
- apiTokenAuth
Request parameters
token
querystring
Token.
next_page_token_abc
limit
querynumber
Result limit.
1
active_mode
querystring
active mode field.
activated
show_bot
queryboolean
show bot field.
true
user_ids
querystring
User ID list.
user_id_123
nickname
querystring
Nickname.
Alice
nickname_startswith
querystring
nickname startswith field.
Alice
metadatakey
querystring
metadatakey field.
metadata_key
metadatavalues_in
querystring
metadatavalues in field.
metadata_value
Responses
200
ListUsersResponseapplication/json
Request succeeded.
Properties: nextusers
400
SendbirdApiErrorapplication/json
Request parameters are invalid.
Properties: codemessage
401
SendbirdApiErrorapplication/json
Unauthenticated or the API token is invalid.
Properties: codemessage
403
SendbirdApiErrorapplication/json
Access to the resource is forbidden.
Properties: codemessage
404
SendbirdApiErrorapplication/json
The requested resource was not found.
Properties: codemessage
429
SendbirdApiErrorapplication/json
Rate limited; retry later.
Properties: codemessage
500
SendbirdApiErrorapplication/json
Upstream internal error.
Properties: codemessage
{
"next": "next_page_token_abc",
"users": []
}