查询用户加入申请接口

查询加入企业的申请记录,返回申请人资料、申请状态及审批时间。取得 request_id 后,可调用加入申请审批接口作出决定。

所需权限

所需权限资源Scope资源服务
用户与席位审批读取(读取)user-approvalsadmin.v1.user-approvals.readqwenwork-biz-service

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 开始。 默认值:1。 最小值:1。1
page_sizequeryinteger · int64每页返回的记录数量。 默认值:20。 最小值:1。 最大值:100。20

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

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

响应

200 请求成功,返回当前或更新后的数据。

名称类型必填说明示例
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>"}]
items[].department_idstring相关部门的标识。"<string>"
items[].department_namestring相关部门的名称。"<string>"
items[].emailstring用户的邮箱地址。"<string>"
items[].employee_numberstring企业为申请人分配的工号。"<string>"
items[].external_idstring来源系统中的标识,用于关联外部对象。"<string>"
items[].idstring此记录的唯一标识,查询、更新或删除对应记录时使用。"<string>"
items[].invitation_idstring提交加入申请时使用的邀请标识。"<string>"
items[].namestring用于识别此对象的名称。"<string>"
items[].phone_numberstring用户的电话号码。"<string>"
items[].requested_atstring · date-time提交申请的时间。"2026-08-27T10:00:00Z"
items[].reviewed_atstring · date-time完成审批的时间;尚未审批时为空。"2026-08-27T10:00:00Z"
items[].statusstring此记录当前所处的状态。"<string>"
pageinteger · int64当前结果页的页码,从 1 开始。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 请求失败,返回错误码和错误详情。

名称类型必填说明示例
codestring用于程序判断错误原因的稳定业务错误码。"<string>"
detailstring便于阅读的错误说明。"<string>"
detailsOpenapiErrorDetails字段校验失败时的详细信息。{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring未通过校验的请求字段。"<string>"
details.reasonstring稳定的校验失败原因,用于判断字段为何不合法。"<string>"
details.suggestionstring建议采用的规范化字段值。"<string>"
errorstring稳定的 HTTP 错误类型。"<string>"
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}