# 获取人才字段

获取全部人才字段详细信息，包含字段名称、字段描述、字段类型、启用状态等信息。

## 概念说明
在「飞书招聘」-「设置」-「候选人字段管理」中，人才中的字段按照模块进行组织，一个模块下可以包含多个字段，对应人才字段类型中`模块`类型，如下图所示。

![image.png](//sf3-cn.feishucdn.com/obj/open-platform-opendoc/ef34f907d66c16101567d67d48b08b06_NDaFV3Wupm.png?maxWidth=500)

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/hire/v1/talent_objects/query
HTTP Method | GET
接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 获取人才信息(hire:talent:readonly)<br>更新人才信息(hire:talent)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | common_schema\[\] | 模块列表
id | string | 模块 ID
name | i18n | 模块名称
zh_cn | string | 模块中文名称
en_us | string | 模块英文名称
description | i18n | 模块描述
zh_cn | string | 模块中文描述
en_us | string | 模块英文描述
setting | common_schema_setting | 模块信息
object_type | int | 字段类型<br>**注意**：模块级别的字段类型只能取值 `11` 模块<br>**可选值有**：<br>- 1：单行文本<br>- 2：多行文本<br>- 3：单选<br>- 4：多选<br>- 5：日期<br>- 6：月份选择<br>- 7：年份选择<br>- 8：时间段<br>- 9：数字<br>- 10：默认字段<br>- 11：模块<br>- 12：日期<br>- 13：附件
config | common_schema_config | 模块配置信息
options | common_schema_option\[\] | 选项信息，模块下该字段不会有值
key | string | 选项 ID
name | i18n | 选项名称
zh_cn | string | 选项中文名称
en_us | string | 选项英文名称
description | i18n | 选项描述
zh_cn | string | 选项中文描述
en_us | string | 选项英文描述
active_status | int | 选项是否启用<br>**可选值有**：<br>- 1：已启用<br>- 2：已停用
is_customized | boolean | 是否是自定义模块<br>- `true` 为自定义模块<br>- `false` 为系统预置模块
is_required | boolean | 是否必填
active_status | int | 模块是否启用<br>**可选值有**：<br>- 1：已启用<br>- 2：已停用
children_list | common_schema_child\[\] | 字段列表
id | string | 字段 ID
name | i18n | 字段名称
zh_cn | string | 字段中文名称
en_us | string | 字段英文名称
description | i18n | 字段描述
zh_cn | string | 字段中文描述
en_us | string | 字段英文描述
setting | common_schema_setting | 字段配置信息
object_type | int | 字段类型<br>**注意**：字段级别的字段类型不能取值 `11` 模块<br>**可选值有**：<br>- 1：单行文本<br>- 2：多行文本<br>- 3：单选<br>- 4：多选<br>- 5：日期<br>- 6：月份选择<br>- 7：年份选择<br>- 8：时间段<br>- 9：数字<br>- 10：默认字段<br>- 11：模块<br>- 12：日期<br>- 13：附件
config | common_schema_config | 配置信息
options | common_schema_option\[\] | 选项信息，当字段类型为 `单选` 或 `多选` 时该字段有值
key | string | 选项 ID
name | i18n | 选项名称
zh_cn | string | 选项中文名称
en_us | string | 选项英文名称
description | i18n | 选项描述
zh_cn | string | 选项中文描述
en_us | string | 选项英文描述
active_status | int | 选项是否启用<br>**可选值有**：<br>- 1：已启用<br>- 2：已停用
parent_id | string | 所属模块 ID
is_customized | boolean | 是否是自定义字段<br>- `true` 为自定义字段<br>- `false` 为系统预置字段
is_required | boolean | 是否必填
active_status | int | 字段是否启用<br>**可选值有**：<br>- 1：已启用<br>- 2：已停用

### 响应体示例
```json
{
    "code": 0,
    "msg": "ok",
    "data": {
        "items": [
            {
                "id": "6949805467799537964",
                "name": {
                    "zh_cn": "教育经历",
                    "en_us": "Education"
                },
                "description": {
                    "zh_cn": "人才的教育经历信息",
                    "en_us": "The education infos of talent"
                },
                "setting": {
                    "object_type": 11,
                    "config": {
                        "options": [
                            {
                                "key": "1",
                                "name": {
                                    "zh_cn": "选项一",
                                    "en_us": "Option 1"
                                },
                                "description": {
                                    "zh_cn": "这是第一个选项",
                                    "en_us": "This is the option 1"
                                },
                                "active_status": 1
                            }
                        ]
                    }
                },
                "is_customized": true,
                "is_required": false,
                "active_status": 1,
                "children_list": [
                    {
                        "id": "6949805467799537964",
                        "name": {
                            "zh_cn": "学历",
                            "en_us": "Degree"
                        },
                        "description": {
                            "zh_cn": "人才的学历是什么",
                            "en_us": "What is the degree of talent"
                        },
                        "setting": {
                            "object_type": 3,
                            "config": {
                                "options": [
                                    {
                                        "key": "1",
                                        "name": {
                                            "zh_cn": "选项一",
                                            "en_us": "Option 1"
                                        },
                                        "description": {
                                            "zh_cn": "这是第一个选项",
                                            "en_us": "This is option 1"
                                        },
                                        "active_status": 1
                                    }
                                ]
                            }
                        },
                        "parent_id": "6949805467799537964",
                        "is_customized": true,
                        "is_required": false,
                        "active_status": 1
                    }
                ]
            }
        ]
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询[技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1002002 | 参数错误 | 检查参数是否正确，例如类型，大小

更多错误码信息，参见[通用错误码](https://open.feishu.cn/document/ukTMukTMukTM/ugjM14COyUjL4ITN)。