Skip to content

查询指定时间范围内当前生效信息发生变更的部门

查询指定时间范围内当前生效信息发生变更的部门,即只有部门当前生效版本的生效时间在查询时间范围内,才返回该部门id

Tip: - 默认排序条件:默认先按照组织记录 ID 增序排序, 便于滚动查询

  • 使用滚动查询而非分页查询,是为了防止大批量获取数据时,深分页导致超时

Warning: - 时间窗支持大范围查询,限定查询范围在90天以内,例如要查询2020年1月1日至2020年6月30日的数据,建议分成两次查询,分别为2020年1月1日至2020年3月31日,2020年4月1日至2020年6月30日,不建议查询大时间范围数据

  • 未来生效的版本数据,会在生效日期当天凌晨产生变更事件。例如:今天为1月1日,新建部门 1月10日生效,则1月10日凌晨 1点之后可查询到。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/departments/query_recent_change
HTTP MethodGET
接口频率限制5 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可corehr:department:read 获取部门信息 corehr:department:write 读写部门信息

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

查询参数

名称类型必填描述
page_sizeint分页大小,最大支持单次 2000 条变更
示例值:100
数据校验规则
- 取值范围:12000
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:6891251722631890445
start_datestring查询的开始时间,格式 "YYYY-MM-DD HH:MM:SS", 以 UTC+8 时区查询变更。
示例值:2024-06-01 00:00:00
end_datestring查询的结束时间,格式 "YYYY-MM-DD HH:MM:SS", 以 UTC+8 时区查询变更。 查询结束时间应大于开始时间。
示例值:2024-08-01 02:10:10
department_id_typestring此次调用中使用的部门 ID 类型
示例值:people_corehr_department_id
可选值有
- open_department_id: 【飞书】用来在具体某个应用中标识一个部门,同一个department_id 在不同应用中的 open_department_id 相同。 - department_id: 【飞书】用来标识租户内一个唯一的部门。 - people_corehr_department_id: 【飞书人事】用来标识「飞书人事」中的部门。
默认值people_corehr_department_id

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ department_idsstring\[\]部门 ID 列表, 其中包含新建、更新以及删除的 ID 列表。 - 非删除的数据,可通过批量查询部门V2 或者搜索部门信息 获取详情
  └ deleted_department_idsstring\[\]目标查询时间范围内被删除的部门列表, 该列表是 department_ids 的子集,便于获取在指定的[start_date, end_date+1) 的范围内被删除的部门 IDs。 - 由于对应的部门已经被删除,无法通过 ID 查询到历史数据。
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "department_ids": [
            "7094136522860922111"
        ],
        "deleted_department_ids": [
            "7094136522860922111"
        ],
        "page_token": "7094136522860922111",
        "has_more": true
    }
}

错误码

HTTP状态码错误码描述排查建议
4001160107参数错误请检查日期格式,以及查询开始时间与结束时间的范围不超过 90 天

内容来源:飞书开放平台 · 自动爬取整理