通过 OpenAPI 查询用户列表。
Qoder CN 系列全新文档站点现已上线。当前站点的文档内容可能无法反映产品的最新功能与变化,请访问 docs.qoder.cn获取最新产品文档。
|
适用版本 |
企业专属版 |
服务接入点
获取服务接入点,替换 API 请求语法中的 {domain}。
授权信息
|
产品 |
资源 |
所需权限 |
|
组织管理 |
用户 |
只读 |
请求语法
GET https://{domain}/oapi/v1/platform/users?filter={filter}&status={status}&deptId={deptId}&page={page}&perPage={perPage}
请求说明 |
查询正常用户信息
查询已删除用户信息
|
请求头(Headers) |
|
|
x-yunxiao-token 个人访问令牌。您可参考个人访问令牌获取。 示例:pt-0fh3****0fbG_35af****0484。 |
|
请求参数 |
|
|
filter 查询信息,支持用户名、登录名、邮箱、手机号等信息的模糊搜索。 |
|
|
status 用户状态。
|
|
|
deptId 所属部门。 |
|
|
page 当前页。 |
|
|
perPage 每页数据条数,取值范围: |
返回参数 |
返回正常用户信息
返回已删除用户信息
|
|
id 用户 ID。 |
|
|
username 登录账号名。 |
|
|
name 显示名称。 |
|
|
nickName 昵称。 |
|
|
email 邮箱。 |
|
|
lastOrganization 上次登录组织。 |
|
|
staffId 工号。 |
|
|
sysDeptIds 所属部门。 |
|
|
createdAt 创建时间。 |
|
|
deletedAt 删除时间。 只有已删除用户才会显示此参数。 |
响应头
|
参数 |
描述 |
示例值 |
|
x-next-page |
下一页 |
2 |
|
x-page |
当前页 |
1 |
|
x-per-page |
每页大小 |
100 |
|
x-prev-page |
前一页 |
0 |
|
x-request-id |
请求 ID |
37294673-00CA-5B8B-914F-A8B35511E90A |
|
x-total |
总数 |
10 |
|
x-total-pages |
总分页数 |
1 |
错误码
访问错误码中心查看 API 相关错误码。