获取企业自定义用户字段

调用该接口查询当前企业内自定义用户字段的配置信息。

使用限制

• 仅当企业管理员在管理后台 > 组织架构 > 字段管理 页面添加了自定义用户字段，并且在 API 调用设置 中开启了 允许开放平台通讯录 API 调用 开关，当前接口才会获取到自定义用户字段数据。本接口只能获取「文本」、「网页」、「单选选项」、「电话」这几个类型的自定义字段。

  

• 仅可获取字段来源为 通用信息 的自定义用户字段数据。如果字段来源为 人事，则无法通过该接口查询到对应的数据。

  

• 仅可获取字段归属为 成员 的自定义字段数据。如果字段归属为 部门，则无法通过该接口查询到对应的数据。

  

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/contact/v3/custom_attrs
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	contact:contact.base:readonly 获取通讯录基本信息

请求头

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

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小，用于限制一次请求所返回的数据条目数。 示例值：10 默认值：20 数据校验规则： - 取值范围：1 ～ 100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：AQD9/Rn9eij9Pm39ED40/RYU5lvOM4s6zgbeeNNaWd%2BVKwAsoreeRWk0J2noGvJy

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	custom_attr\[\]	自定义字段信息集合。
└ id	string	自定义字段 ID。
└ type	string	自定义字段类型。 可能值有： - TEXT：文本类型 - HREF：网页类型 - ENUMERATION：枚举类型 - GENERIC_USER：用户类型 - PICTURE_ENUM：图片类型 关于自定义字段类型的更多信息，可参见自定义用户字段资源介绍。
└ options	custom_attr_options	选项定义，当 type 为 ENUMERATION 或者 PICTURE_ENUM 时此项有值，将列举所有可选项。
└ default_option_id	string	默认选项 ID。
└ option_type	string	选项类型。 可选值有： - TEXT: 文本选项 - PICTURE: 图片选项
└ options	custom_attr_option\[\]	选项列表。
└ id	string	枚举类型选项 ID。
└ value	string	选项值。 - 当 option_type 为 TEXT 时，取值为文本值。 - 当 option_type 为 PICTURE 时，取值为图片链接。
└ name	string	图片名称，仅 option_type 为 PICTURE 时有效。
└ i18n_name	i18n_content\[\]	自定义字段的字段名称。
└ locale	string	语言版本。 可能值有： - zh_cn：中文 - en_us：英文 - ja_jp：日文
└ value	string	语言版本对应的字段名称。
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "C-6965457429001748507",
                "type": "TEXT",
                "options": {
                    "default_option_id": "qasdefgr",
                    "option_type": "TEXT",
                    "options": [
                        {
                            "id": "qasdefgr",
                            "value": "Option",
                            "name": "Name"
                        }
                    ]
                },
                "i18n_name": [
                    {
                        "locale": "zh_cn",
                        "value": "多语言内容"
                    }
                ]
            }
        ],
        "page_token": "AQD9/Rn9eij9Pm39ED40/RYU5lvOM4s6zgbeeNNaWd%2BVKwAsoreeRWk0J2noGvJy",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	40012	page token is invalid error	无效的分页参数。你需要检查传入的 page_token 是否为上次请求返回的 page_token 值。
400	40011	page size is invalid	无效的分页参数。page_size 的取值范围为 1 ~ 100。

更多错误码信息，参见通用错误码。