文档反馈
获取指定部门的详细信息。
所需权限
departments:read
请求说明
- 请求方式：
GET - 请求地址：
{域名}/openapi/v1/departments/{id}
注意事项
本接口不支持使用根别名 "0" 来查询根部门的信息。如需获取根部门的信息，需调用 “批量获取多个部门的信息” 接口。
请求参数
请求头参数
| Header 参数 | 是否必填 | 描述 |
|---|---|---|
Authorization |
是 | 固定取值为 Bearer {access_token}。关于如何获取访问令牌，参考鉴权。 |
查询参数
| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
|
|
string |
是 |
- |
待查询部门的 ID。 部门 ID 可以通过 “获取单个父部门的子部门” 接口或 ”按关键词搜索部门“ 接口获取。 |
响应参数
该接口独有的响应参数如下，参数位于 data 中。通用响应参数参考此文档。
| 参数 | 类型 | 描述 |
|---|---|---|
department_id |
string | 该部门的 ID。 |
parent_department_id |
string | 该部门直属的父部门的 ID。值为 "0" 时表示企业根部门。 |
name |
string | 该部门的名称。 |
full_path |
string | 该部门的完整归属路径。各级部门名称以 / 分隔。 |
depth |
int | 该部门的层级深度。 |
示例
请求示例
curl -X GET "${HOST}/openapi/v1/departments/10001" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"
响应示例
{
"code": 0,
"message": "success",
"request_id": "req_xxx",
"data": {
"department_id": "10001",
"parent_department_id": "0",
"name": "研发部",
"full_path": "公司/研发部",
"depth": 1,
"sort_order": 100,
"ctime": 1780000000,
"mtime": 1780500000,
"version": 3
}
}
错误码
若该接口的请求返回错误码，参考错误码文档进行排查。
文档对您有帮助吗?