批量查询部门(不推荐)
批量查询部门信息,包括部门基本信息、自定义字段信息等
Error: 本接口不再推荐使用(不支持更复杂的字段鉴权功能),请使用批量查询部门V2接口(支持对成本中心、部门负责人、自定义字段鉴权)。
Warning: 延迟说明:数据库主从延迟2s以内,即:直接创建部门后2s内调用此接口可能查询不到数据。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/departments |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | corehr:corehr:readonly 获取核心人事信息 corehr:corehr 更新核心人事信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:"6966234786251671053" |
page_size | string | 是 | 分页大小 示例值:100 |
department_id_list | string\[\] | 否 | 部门ID列表 示例值:7094136522860922111 |
name_list | string\[\] | 否 | 部门名称列表,需精确匹配 示例值:后端研发部 |
user_id_type | string | 否 | 用户 ID 类型 示例值:people_corehr_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID? - people_corehr_id: 以飞书人事的 ID 来识别用户默认值: people_corehr_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
department_id_type | string | 否 | 此次调用中使用的部门 ID 类型 示例值:people_corehr_department_id 可选值有: - open_department_id: 以 open_department_id 来标识部门 - department_id: 以 department_id 来标识部门 - people_corehr_department_id: 以 people_corehr_department_id 来标识部门默认值: people_corehr_department_id |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | department\[\] | 查询的部门信息 |
└ id | string | 部门 ID |
└ sub_type | enum | 部门子类型,枚举值可通过文档【飞书人事枚举常量】部门子类型(department_sub_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ manager | string | 部门负责人 ID,枚举值及详细信息可通过【批量查询员工信息】查询获得 |
└ is_confidential | boolean | 是否保密 |
└ hiberarchy_common | hiberarchy_common | 组织实体公共字段,包括名称、描述、上级、启停用状态、生效日期、编码等基础信息 |
└ parent_id | string | 上级组织 ID |
└ name | i18n\[\] | 名称 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ type | enum | 组织类型,枚举值可通过文档【飞书人事枚举常量】组织类型(organization_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ active | boolean | 是否启用 |
└ effective_time | string | 生效时间 |
└ expiration_time | string | 失效时间 |
└ code | string | 编码 |
└ description | i18n\[\] | 描述 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ tree_order | string | 树形排序,代表同层级的部门排序序号。新建的部门,该字段默认为空,有两种情况会自动写入值: - 管理员在部门管理页面上拖动排序; - 定时任务更新该字段为空的数据,3分钟/次 |
└ list_order | string | 列表排序,代表所有部门的混排序号。新建的部门,该字段默认为空,有两种情况会自动写入值: - 管理员在部门管理页面上拖动排序; - 定时任务更新该字段为空的数据,3分钟/次 |
└ custom_fields | object_field_data\[\] | 自定义字段,枚举值可通过获取自定义字段列表获取 |
└ field_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ effective_time | string | 生效时间 |
└ expiration_time | string | 失效时间 |
└ custom_fields | object_field_data\[\] | 自定义字段,枚举值可通过获取自定义字段列表获取 |
└ field_name | string | 自定义字段 apiname,即自定义字段的唯一标识 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ cost_center_id | string | 成本中心 ID,可以通过搜索成本中心信息接口获取对应的成本中心信息 |
└ staffing_model | enum | 岗职务模式 |
└ enum_name | string | 枚举值:job、non_job、position |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言 |
└ value | string | 内容 |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"id": "6969828847121885087",
"sub_type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"manager": "6893013238632416776",
"is_confidential": true,
"hiberarchy_common": {
"parent_id": "4719168654814483759",
"name": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"type": {
"enum_name": "type_1",
"display": [
{
"lang": "zh-CN",
"value": "张三"
}
]
},
"active": true,
"effective_time": "2020-05-01 00:00:00",
"expiration_time": "2020-05-02 00:00:00",
"code": "12456",
"description": [
{
"lang": "zh-CN",
"value": "张三"
}
],
"tree_order": "001000",
"list_order": "001000-001000",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
]
},
"effective_time": "2020-05-01 00:00:00",
"expiration_time": "2020-05-02 00:00:00",
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"cost_center_id": "7142384817131652652",
"staffing_model": {
"enum_name": "job",
"display": [
{
"lang": "zh-CN",
"value": "刘梓新"
}
]
}
}
],
"has_more": true,
"page_token": "1234452132"
}
}