获取项目列表
获取项目列表(概念上一批集体启动和管理的职位可以定义为一个项目,例如 「2012 秋招项目」)。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/subjects |
| HTTP Method | GET |
| 接口频率限制 | 特殊频控 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | hire:subject:readonly 获取项目信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id_type | string | 否 | 用户 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?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:1231231987 |
page_size | int | 否 | 分页大小, 不能超过 200 示例值:100 默认值: 1 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ items | subject\[\] | 项目列表 |
└ id | string | 项目ID |
└ name | i18n | 名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ create_time | string | 创建时间 |
└ active_status | int | 状态 可选值有: - 1: 已启用 - 2: 已禁用 |
└ application_limit | int | 投递职位数上限,已废弃 |
└ creator | id_name_object | 创建人 |
└ id | string | 创建人用户ID,与查询参数user_id_type的取值相关 |
└ name | i18n | 名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"has_more": true,
"page_token": "1234452132",
"items": [
{
"id": "1213213123123",
"name": {
"zh_cn": "测试",
"en_us": "test"
},
"create_time": "1628512038000",
"active_status": 1,
"application_limit": 1,
"creator": {
"id": "1213213123123",
"name": {
"zh_cn": "测试",
"en_us": "test"
}
}
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1002001 | system error | 请根据实际报错信息定位或咨询技术支持 |
| 400 | 1002002 | parameter error | 检查参数是否正确,例如类型,大小 |
