查询用户列表接口

将 <BASE_URL> 替换为所在企业环境的 API 域名。

  • Scope:admin.v1.user-directory.read
  • 权限项:用户与部门信息读取(user-directory)
  • 权限类型:读取
  • 接口:GET/api/openapi/v1/users

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。

名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key,使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
third_party_user_idsqueryarray | null否Repeated third-party user IDs (at most 100; each 1-255 characters after trimming). Case-sensitive exact match, intersected with other filters and application user scope. Empty values are rejected. Omit to leave this filter unset.["<string>"]
keywordquerystring否-"<string>"
department_idquerystring · uuid否-"<uuid>"
statusquerystring否-"pending"
seat_statusquerystring否-"assigned"
pagequeryinteger · int64否-1
page_sizequeryinteger · int64否-20

请求示例

cURL

curl --request GET \
  --url '<BASE_URL>/api/openapi/v1/users?third_party_user_ids=<third_party_user_ids>&keyword=<keyword>&department_id=<department_id>&status=<status>&seat_status=<seat_status>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray | null是-[{"account":"<string>","department_ids":["<string>"],"email":"<string>","job_number":"<string>","name":"<string>","phone":"<string>","qid":"<uuid>","seat_status":"assigned","source":"manual","status":"pending","updated_at":"2026-08-27T10:00:00Z"}]
pageinteger · int64是-0
page_sizeinteger · int64是-0
totalinteger · int64是-0

响应示例

{
  "items": [
    {
      "account": "<string>",
      "department_ids": [
        "<string>"
      ],
      "email": "<string>",
      "job_number": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "qid": "<uuid>",
      "seat_status": "assigned",
      "source": "manual",
      "status": "pending",
      "updated_at": "2026-08-27T10:00:00Z"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否-{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring否Request field that failed validation"<string>"
details.reasonstring否Stable validation failure reason"<string>"
details.suggestionstring否Suggested normalized value"<string>"
errorstring是Stable HTTP error type"<string>"

响应示例

{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}