飞书开放平台 Server API 文档

主题

获取任职信息列表 ​

获取任职信息列表。

Tip: 该接口会按照应用拥有的「员工资源」的权限范围返回数据，请确定在「开发者后台 - 权限管理 - 数据权限」中已申请「员工资源」权限范围

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/employees/job_datas/query
HTTP MethodPOST
接口频率限制100 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可corehr:employee.job_data:read 查看员工的任职信息 corehr:job_data:read 查看任职信息 corehr:job_data:write 读写任职信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 corehr:employment.job:read 获取员工的职务信息 corehr:employment.job_level:read 获取职务级别信息 corehr:employment.pathway:read 获取员工通道信息 corehr:employment.pathway:write 读写员工通道 corehr:employment.position:read 获取员工的岗位信息 corehr:employment.position:write 读写员工的岗位信息 corehr:job_data.assignment_start_reason:read 查看任职记录的原因字段 corehr:employment.job_grade:write 读写职等信息 contact:user.employee_id:readonly 获取用户 user ID corehr:employment.job_level:write 读写员工的职务级别信息 corehr:employment.job_grade:read 获取职等信息 corehr:job_data.compensation_type:read 获取薪资类型 corehr:job_data.job_data_reason:read 读取任职原因 corehr:job_data.service_company:read 获取任职公司 corehr:job_data.work_shift:read 获取排班信息

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Typestring是固定值："application/json; charset=utf-8"

查询参数 ​

名称类型必填描述
page_sizeint是分页大小，最大 100
示例值：100
数据校验规则：
- 取值范围：1 ～ 100
page_tokenstring否分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
示例值：6891251722631890445
user_id_typestring否用户 ID 类型
示例值：open_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 来识别用户
默认值：open_id
当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID
department_id_typestring否此次调用中使用的部门 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

请求体 ​

名称类型必填描述
get_all_versionboolean否是否获取所有版本的任职记录 - true 为获取员工所有版本的任职记录 - false 为仅获取当前生效的任职记录 - 默认为 false
示例值：false
data_datestring否查看数据日期 - 与时间范围筛选为 AND 关系 - 默认为当天
示例值："2020-01-01"
effective_date_startstring否生效日期 - 搜索范围开始 - 默认为空
示例值："2020-01-01"
effective_date_endstring否生效日期 - 搜索范围结束 - 默认为空
示例值："2020-01-01"
department_idstring否员工当前所在的部门 ID - 类型应与 department_id_type 一致
示例值："6891251722631890445"
employment_idsstring\[\]否员工雇佣 ID 列表 - 类型应与 user_id_type 一致
示例值：["7140964208476371111"]
数据校验规则：
- 长度范围：0 ～ 100
primary_job_databoolean否是否仅查询主职 - true：仅返回 primary_job_data 为 true 的任职记录 - false：仅返回 primary_job_data 为 false 的任职记录 - 不传：返回全部
示例值：true
assignment_start_reasonsstring\[\]否业务类型（原：任职原因） - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：job_data - custom_api_name：assignment_start_reason
示例值：["onboarding"]
默认值：[]

请求体示例 ​

json
{
    "get_all_version": false,
    "data_date": "2020-01-01",
    "effective_date_start": "2020-01-01",
    "effective_date_end": "2020-01-01",
    "department_id": "6891251722631890445",
    "employment_ids": [
        "7140964208476371111"
    ],
    "primary_job_data": true,
    "assignment_start_reasons": [
        "onboarding"
    ]
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ itemsemployee_job_data\[\]任职信息
    └ employment_idstring员工雇佣 ID - 类型与 user_id_type 一致
    └ job_datasjob_data\[\]任职记录
      └ job_data_idstring任职信息 ID
      └ version_idstring任职记录版本 ID
      └ employee_type_idstring人员类型 ID，可通过【查询单个人员类型】获取详细信息
      └ working_hours_type_idstring工时制度 ID，可通过【查询单个工时制度】获取详细信息
      └ work_location_idstring工作地点 ID，可通过【查询单个地点】获取详细信息
      └ department_idstring部门 ID，可通过【批量查询部门】接口查询详细信息 - 与 department_id_type 类型一致
      └ position_idstring岗位 ID - 功能灰度中，如有需求请联系技术支持
字段权限要求（满足任一）： corehr:employment.position:read 获取员工的岗位信息 corehr:employment.position:write 读写员工的岗位信息
      └ job_idstring职务 ID，可通过【查询单个职务】获取详细信息
字段权限要求（满足任一）： corehr:employment.job:read 获取员工的职务信息 corehr:employment.job_level:read 获取职务级别信息 corehr:employment.job_level:write 读写员工的职务级别信息
      └ job_level_idstring职级 ID，可通过【查询单个职级】获取详细信息
字段权限要求（满足任一）： corehr:employment.job_level:read 获取职务级别信息 corehr:employment.job_level:write 读写员工的职务级别信息
      └ job_grade_idstring职等 ID，可通过【查询职等】获取详细信息
字段权限要求（满足任一）： corehr:employment.job_grade:read 获取职等信息 corehr:employment.job_grade:write 读写职等信息
      └ job_family_idstring序列 ID，可通过【查询单个序列】获取详细信息
      └ probation_start_datestring试用期开始日期
      └ probation_end_datestring试用期结束日期（实际结束日期）
      └ primary_job_databoolean是否为主任职 - true：主职 - false：兼职，建议使用兼职相关接口
      └ employment_idstring雇佣 ID，可通过【批量查询员工信息】获取详细信息
- 与 user_id_type 类型一致
      └ effective_timestring任职记录版本的生效时间
      └ expiration_timestring任职记录版本的失效时间
      └ assignment_start_reasonenum业务类型（原：任职原因） - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：job_data - custom_api_name：assignment_start_reason
字段权限要求： corehr:job_data.assignment_start_reason:read 查看任职记录的原因字段
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言编码（IETF BCP 47）
          └ valuestring文本内容
      └ probation_expected_end_datestring预计试用期结束日期
      └ probation_outcomeenum试用期结果 - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：job_data - custom_api_name：probation_outcome
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言编码（IETF BCP 47）
          └ valuestring文本内容
      └ direct_managerbasic_job_data直属上级
        └ job_data_idstring任职信息 ID，可通过【查询单个任职信息】获取详细信息
        └ employment_idstring雇佣 ID，可通过【批量查询员工信息】获取详细信息
- 与 user_id_type 类型一致
      └ dotted_line_managersbasic_job_data\[\]虚线上级
        └ job_data_idstring任职信息 ID，可通过【查询单个任职信息】获取详细信息
        └ employment_idstring雇佣 ID，可通过【批量查询员工信息】获取详细信息 - 与 user_id_type 类型一致
      └ second_direct_managerbasic_job_data第二实线主管
        └ job_data_idstring任职信息 ID，可通过【查询单个任职信息】获取详细信息
        └ employment_idstring雇佣 ID，可通过【批量查询员工信息】获取详细信息 - 与 user_id_type 类型一致
      └ cost_center_ratesjob_data_cost_center\[\]成本中心分摊信息
        └ cost_center_idstring成本中心 ID，可以通过搜索成本中心信息接口获取对应的成本中心信息
        └ rateint分摊比例(整数)
        └ new_ratenumber(float)分摊比例
      └ work_shiftenum排班类型，可通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "job_data" - custom_api_name = "work_shift"
字段权限要求： corehr:job_data.work_shift:read 获取排班信息
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言编码（IETF BCP 47）
          └ valuestring文本内容
      └ compensation_typeenum薪资类型，可通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "job_data" - custom_api_name = "compensation_type"
字段权限要求： corehr:job_data.compensation_type:read 获取薪资类型
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言编码（IETF BCP 47）
          └ valuestring文本内容
      └ service_companystring任职公司，可通过【查询单个公司】获取详细信息
字段权限要求： corehr:job_data.service_company:read 获取任职公司
      └ weekly_working_hours_v2number(float)周工作时长 V2
      └ weekly_working_hoursint周工作时长
      └ employee_subtype_idstring人员子类型 ID - 功能灰度中，如有需求请联系技术支持
      └ job_data_reasonenum任职原因 - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name = "job_data" - custom_api_name = "job_data_reason"
字段权限要求： corehr:job_data.job_data_reason:read 读取任职原因
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言编码（IETF BCP 47）
          └ valuestring文本内容
      └ pathway_idstring通道 ID
字段权限要求（满足任一）： corehr:employment.pathway:read 获取员工通道信息 corehr:employment.pathway:write 读写员工通道
  └ page_tokenstring分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "employment_id": "6893014062142064135",
                "job_datas": [
                    {
                        "job_data_id": "6890452208593372679",
                        "version_id": "6890452208593372697",
                        "employee_type_id": "6890452208593372679",
                        "working_hours_type_id": "6890452208593372679",
                        "work_location_id": "6890452208593372679",
                        "department_id": "6890452208593372679",
                        "position_id": "6890452208593372679",
                        "job_id": "6890452208593372679",
                        "job_level_id": "6890452208593372679",
                        "job_grade_id": "6890452208593372679",
                        "job_family_id": "1245678",
                        "probation_start_date": "2018-03-16T00:00:00",
                        "probation_end_date": "2019-05-24T00:00:00",
                        "primary_job_data": true,
                        "employment_id": "6893014062142064135",
                        "effective_time": "2020-05-01 00:00:00",
                        "expiration_time": "2020-05-02 00:00:00",
                        "assignment_start_reason": {
                            "enum_name": "onboarding",
                            "display": [
                                {
                                    "lang": "zh-CN",
                                    "value": "中文示例"
                                }
                            ]
                        },
                        "probation_expected_end_date": "2006-01-02",
                        "probation_outcome": {
                            "enum_name": "example",
                            "display": [
                                {
                                    "lang": "zh-CN",
                                    "value": "中文示例"
                                }
                            ]
                        },
                        "direct_manager": {
                            "job_data_id": "1000000",
                            "employment_id": "6893014062142064135"
                        },
                        "dotted_line_managers": [
                            {
                                "job_data_id": "1000000",
                                "employment_id": "6893014062142064135"
                            }
                        ],
                        "second_direct_manager": {
                            "job_data_id": "1000000",
                            "employment_id": "6893014062142064135"
                        },
                        "cost_center_rates": [
                            {
                                "cost_center_id": "6950635856373745165",
                                "rate": 100,
                                "new_rate": 50.2
                            }
                        ],
                        "work_shift": {
                            "enum_name": "example",
                            "display": [
                                {
                                    "lang": "zh-CN",
                                    "value": "中文示例"
                                }
                            ]
                        },
                        "compensation_type": {
                            "enum_name": "example",
                            "display": [
                                {
                                    "lang": "zh-CN",
                                    "value": "中文示例"
                                }
                            ]
                        },
                        "service_company": "6890452208593372680",
                        "weekly_working_hours_v2": 10.1,
                        "weekly_working_hours": 10,
                        "employee_subtype_id": "6890452208593372680",
                        "job_data_reason": {
                            "enum_name": "example_option",
                            "display": [
                                {
                                    "lang": "zh-CN",
                                    "value": "晋升"
                                }
                            ]
                        },
                        "pathway_id": "6890452208593372679"
                    }
                ]
            }
        ],
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4001160013Param is invalid请检查参数格式是否错误
4001160018AppID or LarkTenantID missing请检查 AppID 或 LarkTenantID 是否填写
4001160023No authority error请检查是否有权限
5001160999unknown error请联系技术支持
5001160997Unknown meta rpc error请联系技术支持
5001160998Unknown vault rpc error请联系技术支持

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

本镜像仅供学习与查阅，文档版权归飞书所有