获取飞书人事对象列表
获取「飞书人事」中的对象列表,含系统预置对象与自定义对象。使用方式可参考【操作手册】如何通过 OpenAPI 维护自定义字段
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/custom_fields/list_object_api_name |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | corehr:common_data.meta_data:read 获取元数据信息 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 获取查询结果 示例值:11 |
page_size | string | 是 | 分页大小 示例值:100 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | object\[\] | 对象列表 |
└ object_api_name | string | 对象的唯一标识 |
└ name | name | 对象名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ is_open | boolean | 是否启用 |
└ create_time | string | 创建时间,秒级时间戳 |
└ update_time | string | 更新时间,秒级时间戳 |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"object_api_name": "offboarding_info",
"name": {
"zh_cn": "cn",
"en_us": "en"
},
"is_open": false,
"create_time": "1644992809",
"update_time": "1644992809"
}
],
"has_more": true,
"page_token": "3"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1160009 | page token format error | 输入参数 page_token 的格式有误,请检查 |
| 500 | 1160997 | unknown meta rpc error | 服务内部错误,请稍后重试。如有问题请联系技术支持 |
