查询部门列表

最近更新时间:2024-07-08 11:48:53

我的收藏

接口描述

描述:查询企业部门列表,仅企业下具有部门查询权限的用户可查询部门列表。不支持 OAuth2.0 鉴权访问。
请求方式:GET
自建应用权限点:查看企业部门,管理企业部门。
接口请求域名
https://api.meeting.qq.com/v1/departments?userid={userid}&department_id={department_id}&page={page}&page_size={page_size}


输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
userid
String
接口调用者 userid,必须为企业下具有部门查询权限的用户。
department_id
String
部门 ID(不传时输出全部部门列表,为0时输出全部主部门列表,其他情况返回该部门下子部门列表)。
page
Integer
分页,默认为1,最小值为1。
page_size
Integer
分页大小,默认为20,取值范围[1,20]。

输出参数

成功输出以下字段,失败则返回 错误码 和错误信息。
参数名称
参数类型
参数描述
total_page
Integer
数据总页数。
total_count
Integer
数据总条数。
department_list
DepartmentList 对象数组
部门对象列表。
current_size
Integer
当前页实际大小。
current_page
Integer
当前页。

DepartmentList 对象

参数名称
参数类型
参数描述
department_id
String
部门 ID。
department_name
String
部门名称。
department_full_name
String
部门全称。
is_main_department
Boolean
是否是主部门。

错误码列表

状态码
错误码
错误描述
500
190443
用户无部门操作权限。场景:
1. 用户无编辑部门信息权限
2. 用户无查看部门信息权限
400
500014
账号无权限。
400
190004
参数非法,请对照接口文档检查您的参数。

示例

输入示例

GET
https://api.meeting.qq.com/v1/departments?userid=meeting4548079&page=1&page_size=20

输出示例

{
"total_count": 4,
"total_page": 1,
"current_page": 1,
"current_size": 4,
"department_list": [{
"department_id": "e99f0********65361e1c78c7e08465b",
"department_name": "test-子部门-02",
"department_full_name": "test-主部门-01/test-子部门-02",
"is_main_department": false
}, {
"department_id": "b3295fd11********843532c689536",
"department_name": "test-子部门-01",
"department_full_name": "test-主部门-01/test-子部门-01",
"is_main_department": false
}, {
"department_id": "07f4c15b6616**********966815d251",
"department_name": "test-主部门-02",
"department_full_name": "test-主部门-02",
"is_main_department": true
}, {
"department_id": "1519a9a1a985e**********a464bf856",
"department_name": "test-主部门-01",
"department_full_name": "test-主部门-01",
"is_main_department": true
}]
}