SendbirdSendbird 聊天平台服务端 API v3
GET/v3/users
查询用户列表
分页获取应用内的用户列表。可通过多种查询参数组合定制筛选范围，生成符合需求的用户列表。
通过官方 Sendbird Chat Platform API v3 管理用户、群组频道、开放频道、消息、元数据、审核、机器人与公告。完整边界为固定官方生成 SDK revision 重建的 83 个 REST Endpoint；客户端实时协议与 Chat SDK 不在本集合内。应用数据为调用方私有内容，Pontx 不代理、缓存或聚合，调用方使用本地 SDK/CLI 直连。
请求
- operationId
listUsers- 服务器
https://api-{app_id}.sendbird.com- 认证
- apiTokenAuth
请求参数
token
querystring
令牌
next_page_token_abc
limit
querynumber
返回条数上限
1
active_mode
querystring
active mode 字段。
activated
show_bot
queryboolean
show bot 字段。
true
user_ids
querystring
用户 ID 列表
user_id_123
nickname
querystring
昵称
Alice
nickname_startswith
querystring
nickname startswith 字段。
Alice
metadatakey
querystring
metadatakey 字段。
metadata_key
metadatavalues_in
querystring
metadatavalues in 字段。
metadata_value
响应
200
ListUsersResponseapplication/json
请求成功。
字段: nextusers
400
SendbirdApiErrorapplication/json
请求参数无效。
字段: codemessage
401
SendbirdApiErrorapplication/json
未认证或 API 令牌无效。
字段: codemessage
403
SendbirdApiErrorapplication/json
无权限访问该资源。
字段: codemessage
404
SendbirdApiErrorapplication/json
未找到指定资源。
字段: codemessage
429
SendbirdApiErrorapplication/json
请求频率超限，请稍后重试。
字段: codemessage
500
SendbirdApiErrorapplication/json
上游服务内部错误。
字段: codemessage
{
"next": "next_page_token_abc",
"users": []
}