批量查询合同
通过接口可以批量查询合同列表信息,目前暂不支持其他筛选条件且一次查询最多支持50条数据。
Tip: 如果你只需要单一合同查询场景,建议通过【查询单个合同接口】获取合同信息。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/contracts |
| HTTP Method | GET |
| 接口频率限制 | 特殊频控 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | corehr:corehr:readonly 获取核心人事信息 corehr:corehr 更新核心人事信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:10 |
page_size | string | 是 | 分页大小;范围:0~50 示例值:10 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | contract\[\] | 查询的合同信息 |
└ id | string | 合同ID |
└ effective_time | string | 合同开始日期 |
└ expiration_time | string | 实际结束日期 |
└ employment_id | string | 雇佣 ID,详细信息可通过【查询员工信息接口】获取 |
└ contract_type | enum | 合同类型,枚举值可通过文档【飞书人事枚举常量】合同类型(contract_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ first_party_company_id | string | 合同主体ID, 详细信息可通过【查询公司详情接口】接口查询获得 |
└ person_id | string | Person ID,详细信息可通过接口文档【批量查询员工信息接口】接口查询获得 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ duration_type | enum | 期限类型,枚举值可通过文档【飞书人事枚举常量】合同期限类型(duration_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ contract_end_date | string | 合同结束日期 |
└ contract_number | string | 合同编号 |
└ signing_type | enum | 签订类型,枚举值可通过文档【飞书人事枚举常量】签订类型(signing_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ contract_status | enum | 合同协议状态,枚举值可通过文档【飞书人事枚举常量】合同协议状态(contract_status)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言 |
└ value | string | 内容 |
└ renewal_status | enum | 续签状态,枚举值可通过文档【飞书人事枚举常量】续签状态(renewal_status)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 语言 |
└ value | string | 内容 |
└ signing_times | int | 第几次签署 |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"id": "6919737965274990093",
"effective_time": "2050-01-01 00:00:00",
"expiration_time": "9999-12-31 23:59:59",
"employment_id": "6893013238632416776",
"contract_type": {
"enum_name": "labor_contract",
"display": [
{
"lang": "zh-CN",
"value": "劳动合同"
}
]
},
"first_party_company_id": "6892686614112241165",
"person_id": "151515151",
"custom_fields": [
{
"field_name": "name",
"value": "Sandy"
}
],
"duration_type": {
"enum_name": "fix_term",
"display": [
{
"lang": "zh-CN",
"value": "固定期限类型"
}
]
},
"contract_end_date": "2006-01-02",
"contract_number": "6919737965274990093",
"signing_type": {
"enum_name": "new",
"display": [
{
"lang": "zh-CN",
"value": "新签"
}
]
},
"contract_status": {
"enum_name": "to_be_effective",
"display": [
{
"lang": "zh-CN",
"value": "待生效"
}
]
},
"renewal_status": {
"enum_name": "rejected",
"display": [
{
"lang": "zh-CN",
"value": "已拒绝"
}
]
},
"signing_times": 1
}
],
"has_more": true,
"page_token": "1234452132"
}
}