查询部门信息

调用该接口查询部门信息,包括部门ID、名称、层级关系、负责人及用户数量等信息。

注意事项

默认返回部门基础信息,部分字段(如用户数量、负责人)需通过请求参数指定获取。

请求

基本
请求方式GET
请求地址/openapi/v3/contacts/departments/:department_id

请求头

名称类型必填描述
Authorizationstring值格式Bearer {{access_token}}

调用 API 时,需要通过访问凭证(access_token)进行身份鉴权,不同类型的访问凭证可获取的数据范围不同,参考 获取访问凭证

支持鉴权类型:
应用级token:以应用身份调用 API,校验应用的数据访问范围。参考 获取企业内部应用access_token
用户级token:以登录用户身份调用 API,校验用户的可见数据范围。参考 获取登录用户access_token
Content-Typestring固定值:application/json; charset=utf-8

路径参数

名称类型必填描述
department_iduint64部门ID

请求参数

名称类型必填描述
need_direct_user_countbool是否需要直属用户数量
need_recurve_user_countbool是否需要非直属用户数量
与need_direct_user_count互斥
need_manager_union_idsbool是否需要部门负责人

响应

响应体

1{
2 "code": 0,
3 "data": {
4 "department": {
5 "department_id": "string",
6 "department_name": "string",
7 "has_child": true,
8 "department_parent_id": "string",
9 "manager_union_ids": [
10 "222",
11 "333"
12 ],
13 "direct_user_count": 100,
14 "recurve_user_count": 100
15 }
16 },
17 "msg": "ok",
18 "trace_id": "ae4bd3d6d939f7790fa354e2402450e0"
19}