Skip to main content

查询部门列表接口

查询组织的部门目录，并按关键词或上级部门筛选。返回部门标识及父子关系，可用于构建部门选择器或填写用户的 department_ids。

  • Scope：admin.v1.user-directory.read
  • 权限项：用户与部门信息读取（user-directory）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/departments

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
keywordquerystring否搜索关键词"<string>"
parent_idquerystring · uuid否上级部门（部门 ID）"<uuid>"
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://dev-develop.dev-vpc.qwenwork.cn/api/openapi/v1/departments?keyword=<keyword>&parent_id=<parent_id>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray ｜ null是部门列表-
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
totalinteger · int64是总条数0

items[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
department_idstring · uuid是部门 ID
external_idstring否第三方部门 ID
namestring是部门名称
orderinteger · int64是排序
parent_idstring ｜ null是上级部门（部门 ID）
{
  "items": [
    {
      "department_id": "<uuid>",
      "external_id": "<string>",
      "name": "<string>",
      "order": 0,
      "parent_id": "<string>"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}