查询用户列表_通义灵码_智能编码助手_智能编码助手通义灵码(Lingma)-阿里云帮助中心

通过 OpenAPI 查询用户列表。

适用版本

企业专属版

服务接入点

获取服务接入点，替换 API 请求语法中的 {domain} 。

产品	资源	所需权限
组织管理	用户	只读

GET https://{domain}/oapi/v1/platform/users?filter={filter}&status={status}&deptId={deptId}&page={page}&perPage={perPage}

请求说明	查询正常用户信息 `curl -X 'GET' \ 'https://test-domain-*.rdc.aliyuncs.com/oapi/v1/platform/users' \ -H 'Content-Type: application/json' \ -H 'x-yunxiao-token: pt-0fh30fbG_35af0484'` 查询已删除用户信息 `curl -X 'GET' \ 'https://test-domain-.rdc.aliyuncs.com/oapi/v1/platform/users?status=deleted' \ -H 'Content-Type: application/json' \ -H 'x-yunxiao-token: pt-0fh3*0fbG_35af**0484'`
请求头（Headers）
x-yunxiao-token `string` （必选）个人访问令牌。您可参考个人访问令牌获取。示例：pt-0fh3**0fbG_35af**0484。
请求参数
filter `string` （可选）查询信息，支持用户名、登录名、邮箱、手机号等信息的模糊搜索。
status `string` （可选）用户状态。 `enabled`：正常用户。 `deleted`：已删除用户。
deptId `string` （可选）所属部门。
page `integer` （可选）默认值为`1` 当前页。
perPage `integer` （可选）默认值为`100` 每页数据条数，取值范围：`[1, 100]` 。

返回参数	返回正常用户信息 `[ { "id": "c75d6f21-2af7-4d8e-b0fb-bac25128**", "username": "tmp_test2", "name": "临时测试账号2", "sysDeptIds": [ "9e415b19-10bc-4bb6-a34f-2045a59a" ], "lastOrganization": "3deba052-8501-4f30-a52d-3e9b1ca8", "createdAt": "2025-06-10T06:45:29Z" }, { "id": "85c7aa62-8da7-4f2d-8c99-4b90a253", "username": "tmp_test1", "name": "临时测试账号1", "sysDeptIds": [ "9e415b19-10bc-4bb6-a34f-2045a59a" ], "createdAt": "2025-06-10T06:44:57Z" } ]` 返回已删除用户信息 `[ { "id": "3d4caf00-0004-4a07-9cb7-18c9559d", "username": "doc-test4", "name": "文档测试用户4", "nickName": "昵称4", "email": "doc-test4@example.com", "staffId": "1004", "sysDeptIds": [ "ebeb5a64-c98c-478a-9d9d-513841da**" ], "createdAt": "2025-06-13T05:41:53Z", "deletedAt": "2025-06-13T06:36:43Z" } ]`
id `string` 用户 ID。
username `string` 登录账号名。
name `string` 显示名称。
nickName `string` 昵称。
email `string` 邮箱。
lastOrganization `string` 上次登录组织。
staffId `string` 工号。
sysDeptIds `array[string]` 所属部门。
createdAt `string` 创建时间。
deletedAt `string` 删除时间。只有已删除用户才会显示此参数。

访问错误码中心查看 API 相关错误码。