Skip to content

获取租户序列列表

调用该接口获取当前租户下的序列信息,包含序列的名称、描述、启用状态以及 ID 等。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/contact/v3/job_families
HTTP MethodGET
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可contact:job_family:readonly 查询租户下工作序列的详细信息 contact:job_family 创建、删除、更新租户的工作序列 contact:contact:readonly_as_app 以应用身份读取通讯录

请求头

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

查询参数

名称类型必填描述
page_sizeint分页大小,用于限制一次请求所返回的数据条目数。
示例值:10
默认值10
数据校验规则
- 取值范围:150
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:3
namestring序列名称。
- 传入该字段时,可查询指定序列名称对应的序列信息(不支持模糊查询)。 - 不传入该字段时,查询当前租户下所有序列的信息。
示例值:产品
数据校验规则
- 长度范围:1100 字符

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsjob_family\[\]序列信息。
    └ namestring序列名称。
    └ descriptionstring序列描述。
    └ parent_job_family_idstring上级序列 ID。
    └ statusboolean是否启用序列。
可能值有
- true:启用 - false:禁用
    └ i18n_namei18n_content\[\]多语言序列名称。
      └ localestring语言版本。
可能值有
- zh_cn:中文 - en_us:英语 - ja_jp:日语
      └ valuestring语言版本对应的值。
    └ i18n_descriptioni18n_content\[\]多语言序列描述。
      └ localestring语言版本。
可能值有
- zh_cn:中文 - en_us:英语 - ja_jp:日语
      └ valuestring语言版本对应的值。
    └ job_family_idstring序列 ID。后续可通过该 ID 更新、查询、删除序列。
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "name": "产品",
                "description": "负责产品策略制定的相关工作",
                "parent_job_family_id": "mga5oa8ayjlpzjq",
                "status": true,
                "i18n_name": [
                    {
                        "locale": "zh_cn",
                        "value": "多语言内容"
                    }
                ],
                "i18n_description": [
                    {
                        "locale": "zh_cn",
                        "value": "多语言内容"
                    }
                ],
                "job_family_id": "mga5oa8ayjlpkzy"
            }
        ],
        "page_token": "AQD9/Rn9eij9Pm39ED40/RD/cIFmu77WxpxPB/2oHfQLZ+G8JG6tK7+ZnHiT7COhD2hMSICh/eBl7cpzU6JEC3J7COKNe4jrQ8ExwBCR",
        "has_more": true
    }
}

更多错误码信息,参见通用错误码

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