# 查询指定日期的部门基本信息 查询指定生效的部门基本信息，含部门名称、部门类型、上级、编码、负责人、是否启用、描述等信息 **注意事项**：延迟说明：数据库主从延迟 2s 以内，即：直接创建部门后2s内调用此接口可能查询不到数据。 ## 请求 基本 |   ---|--- HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/departments/query_timeline HTTP Method | POST 接口频率限制 | [5 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN) 支持的应用类型 | Custom App、Store App 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 获取部门信息(corehr:department:read)
读写部门信息(corehr:department:write) 字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取部门自定义字段(corehr:department.custom_fields:read)
获取部门负责人信息(corehr:department.manager:read)
获取部门组织架构信息(corehr:department.organize:read)
获取用户 user ID(contact:user.employee_id:readonly) ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) Content-Type | string | 是 | **固定值**："application/json; charset=utf-8" ### 查询参数 名称 | 类型 | 必填 | 描述 ---|---|---|--- user_id_type | string | 否 | 用户 ID 类型
**示例值**：people_corehr_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
- people_corehr_id：以飞书人事的 ID 来识别用户
**默认值**：`people_corehr_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly) department_id_type | string | 否 | 此次调用中使用的部门 ID 类型
**示例值**：people_corehr_department_id
**可选值有**：
- open_department_id：【飞书】用来在具体某个应用中标识一个部门，同一个department_id 在不同应用中的 open_department_id 相同。
- department_id：【飞书】用来标识租户内一个唯一的部门。
- people_corehr_department_id：【飞书人事】用来标识「飞书人事」中的部门。
**默认值**：`people_corehr_department_id` ### 请求体 名称 | 类型 | 必填 | 描述 ---|---|---|--- department_ids | string\[\] | 是 | 部门 ID 列表
- 可通过[批量查询部门V2](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get) 或者[搜索部门信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/search) 获取详情
**示例值**：["7094136522860922111"]
**数据校验规则**：
- 长度范围：`0` ～ `100` effective_date | string | 是 | 版本生效日期
- 填写格式：YYYY-MM-DD
- 系统默认为填写日期当天的 00:00:00 生效
- 该接口只支持到最小单位为日
- 日期范围要求:1900-01-01～9999-12-31
**示例值**："2020-01-01"
**数据校验规则**：
- 长度范围：`10` ～ `10` 字符
- 正则校验：`^((([0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]{1}|[0-9]{1}[1-9][0-9]{2}|[1-9][0-9]{3})-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|11)-(0[1-9]|[12][0-9]|30))|(02-(0[1-9]|[1][0-9]|2[0-8]))))|((([0-9]{2})(0[48]|[2468][048]|[13579][26])|((0[48]|[2468][048]|[3579][26])00))-02-29))$` fields | string\[\] | 否 | 需要返回的字段列表，字段可填写的列表如下：
- department_name
- sub_type
- code
- active
- parent_department_id
- manager
- description
- effective_date
- expiration_date
- custom_fields(自定义字段需传入具体的"custom_api_name"详细见[获取自定义字段列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query) ,比如:"shifouleixing_7795__c)
**示例值**：["department_name"]
**数据校验规则**：
- 长度范围：`0` ～ `100` ### 请求体示例 ```json { "department_ids": [ "7094136522860922111" ], "effective_date": "2020-01-01", "fields": [ "department_name" ] } ``` ## 响应 ### 响应体 名称 | 类型 | 描述 ---|---|--- code | int | 错误码，非 0 表示失败 msg | string | 错误描述 data | \- | \- items | department_timeline\[\] | 部门信息 id | string | 部门 ID version_id | string | 部门版本 ID names | i18n\[\] | 部门名称 lang | string | 语言，中文用zh-CN，英文用en-US value | string | 文本内容 sub_type | enum | 部门类型
- 通过[获取字段详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)查询获取。请求参数：object_api_name=department；custom_api_name=subtype。 enum_name | string | 枚举值 display | i18n\[\] | 枚举多语展示 lang | string | 语言编码（IETF BCP 47） value | string | 文本内容 parent_department_id | string | 上级部门 ID
- 可通过[批量查询部门V2](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/batch_get) 或者[搜索部门信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/department/search) 获取详情
- 若查询的是一级部门，则该字段不展示
**字段权限要求**：
获取部门组织架构信息(corehr:department.organize:read) manager | string | 部门负责人，填写员工的雇佣ID
- 详细信息可通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search) 或 [【批量查询员工】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get) 接口获取
**字段权限要求**：
获取部门负责人信息(corehr:department.manager:read) code | string | 编码 effective_date | string | 当前版本生效日期
- 返回格式：YYYY-MM-DD（最小单位到日）
- 日期范围:1900-01-01～9999-12-31 active | boolean | 是否启用 descriptions | i18n\[\] | 描述 lang | string | 语言，中文用zh-CN，英文用en-US value | string | 文本内容 custom_fields | custom_field_data\[\] | 自定义字段类型，详细见[获取自定义字段列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query)
**字段权限要求**：
获取部门自定义字段(corehr:department.custom_fields:read) custom_api_name | string | 自定义字段 apiname，即自定义字段的唯一标识 name | custom_name | 自定义字段名称 zh_cn | string | 中文 en_us | string | 英文 type | int | 自定义字段类型，详细见[获取自定义字段列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/query) value | string | 字段值，是 json 转义后的字符串，根据元数据定义不同，字段格式不同（如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05"） expiration_date | string | 当前版本失效日期
- 返回格式：YYYY-MM-DD（最小单位到日）
- 日期范围：1900-01-01 ～9999-12-31 ### 响应体示例 ```json { "code": 0, "msg": "success", "data": { "items": [ { "id": "4719456877659520852", "version_id": "7238516215202170412", "names": [ { "lang": "zh-CN", "value": "中文示例" } ], "sub_type": { "enum_name": "phone_type", "display": [ { "lang": "zh-CN", "value": "中文示例" } ] }, "parent_department_id": "4719456877659520111", "manager": "6893013238632416777", "code": "D00000456", "effective_date": "2020-05-01", "active": true, "descriptions": [ { "lang": "zh-CN", "value": "中文示例" } ], "custom_fields": [ { "custom_api_name": "name", "name": { "zh_cn": "自定义姓名", "en_us": "Custom Name" }, "type": 1, "value": "\"231\"" } ], "expiration_date": "2020-05-02" } ] } } ``` ### 错误码 HTTP状态码 | 错误码 | 描述 | 排查建议 ---|---|---|--- 503 | 1161204 | Requset timeout | 接口超时，详情可联系飞书人事 [Oncall](https://applink.feishu.cn/TLJpeNdW) 429 | 1161604 | QPS over limit | 接口请求次数超过接口频率限制，可尝试降低请求频率