查询用户加入申请接口

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

  • Scope:admin.v1.user-approvals.read
  • 权限项:用户与席位审批读取(user-approvals)
  • 权限类型:读取
  • 接口:GET/api/openapi/v1/join-requests

认证与请求头

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

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

请求参数

名称位置类型必填说明示例
keywordquerystring否-"<string>"
pagequeryinteger · int64否-1
page_sizequeryinteger · int64否-20

请求示例

cURL

curl --request GET \
  --url '<BASE_URL>/api/openapi/v1/join-requests?keyword=<keyword>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray | null是-[{"department_id":"<string>","department_name":"<string>","email":"<string>","employee_number":"<string>","external_id":"<string>","id":"<string>","invitation_id":"<string>","name":"<string>","phone_number":"<string>","requested_at":"2026-08-27T10:00:00Z","reviewed_at":"2026-08-27T10:00:00Z","status":"<string>"}]
pageinteger · int64是-0
page_sizeinteger · int64是-0
total_itemsinteger · int64是-0
total_pagesinteger · int64是-0

响应示例

{
  "items": [
    {
      "department_id": "<string>",
      "department_name": "<string>",
      "email": "<string>",
      "employee_number": "<string>",
      "external_id": "<string>",
      "id": "<string>",
      "invitation_id": "<string>",
      "name": "<string>",
      "phone_number": "<string>",
      "requested_at": "2026-08-27T10:00:00Z",
      "reviewed_at": "2026-08-27T10:00:00Z",
      "status": "<string>"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_items": 0,
  "total_pages": 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>"
}