Skip to content

批量查询合同

通过接口可以批量查询合同列表信息,目前暂不支持其他筛选条件且一次查询最多支持50条数据。

Tip: 如果你只需要单一合同查询场景,建议通过【查询单个合同接口】获取合同信息。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v1/contracts
HTTP MethodGET
接口频率限制特殊频控
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可corehr:corehr:readonly 获取核心人事信息 corehr:corehr 更新核心人事信息

请求头

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

查询参数

名称类型必填描述
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:10
page_sizestring分页大小;范围:0~50
示例值:10

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemscontract\[\]查询的合同信息
    └ idstring合同ID
    └ effective_timestring合同开始日期
    └ expiration_timestring实际结束日期
    └ employment_idstring雇佣 ID,详细信息可通过【查询员工信息接口】获取
    └ contract_typeenum合同类型,枚举值可通过文档【飞书人事枚举常量】合同类型(contract_type)枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring名称信息的语言
        └ valuestring名称信息的内容
    └ first_party_company_idstring合同主体ID, 详细信息可通过【查询公司详情接口】接口查询获得
    └ person_idstringPerson ID,详细信息可通过接口文档【批量查询员工信息接口】接口查询获得
    └ custom_fieldsobject_field_data\[\]自定义字段
      └ field_namestring字段名
      └ valuestring字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")
    └ duration_typeenum期限类型,枚举值可通过文档【飞书人事枚举常量】合同期限类型(duration_type)枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring名称信息的语言
        └ valuestring名称信息的内容
    └ contract_end_datestring合同结束日期
    └ contract_numberstring合同编号
    └ signing_typeenum签订类型,枚举值可通过文档【飞书人事枚举常量】签订类型(signing_type)枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring名称信息的语言
        └ valuestring名称信息的内容
    └ contract_statusenum合同协议状态,枚举值可通过文档【飞书人事枚举常量】合同协议状态(contract_status)枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言
        └ valuestring内容
    └ renewal_statusenum续签状态,枚举值可通过文档【飞书人事枚举常量】续签状态(renewal_status)枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言
        └ valuestring内容
    └ signing_timesint第几次签署
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记,当 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"
    }
}

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