列取自定义字段

列取用户可访问的自定义字段列表。如果不提供resource_type和resource_id参数，则返回用户可访问的所有自定义字段。

如果提供resource_type和resource_id，则返回该资源下的自定义字段。目前resource_type仅支持"tasklist"，此时resource_id应为一个清单的tasklist_guid。

该接口支持分页。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/task/v2/custom_fields
HTTP Method	GET
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	task:custom_field:read 查看自定义字段信息 task:custom_field:write 查看、创建、更新自定义字段
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小 示例值：50 默认值：50 数据校验规则： - 取值范围：1 ～ 100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：aWQ9NzEwMjMzMjMxMDE=
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
resource_type	string	否	资源类型，如提供表示仅查询特定资源下的自定义字段。目前只支持tasklist。 示例值：tasklist
resource_id	string	否	要查询自定义字段的归属resource_id 示例值：5ffbe0ca-6600-41e0-a634-2b38cbcf13b8

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	custom_field\[\]	返回的自定义字段列表
└ guid	string	自定义字段的GUID
└ name	string	自定义字段名称
└ type	string	自定义字段类型
└ number_setting	number_setting	数字类型的字段设置
└ format	string	数字展示的格式 可选值有： - normal: 常规数字 - percentage: 百分比格式 - cny: 人民币格式 - usd: 美元格式 - custom: 自定义符号
└ custom_symbol	string	自定义符号。只有format设为custom时才会生效。
└ custom_symbol_position	string	自定义符号显示的位置。 可选值有： - left: 自定义符号放在数字左边 - right: 自定义符号放在数字右边
└ separator	string	分隔符样式 可选值有： - none: 无分隔符 - thousand: 千分位分隔符
└ decimal_count	int	保留小数位数。输入的数字值的小数位数如果比该设置多，多余的位数将被四舍五入后舍弃。如果format为"percentage"，表示变为百分数之后的小数位数。
└ member_setting	member_setting	人员类型的字段设置
└ multi	boolean	是否支持多选
└ datetime_setting	datetime_setting	时间日期类型的字段设置
└ format	string	日期显示格式
└ single_select_setting	select_setting	单选类型的字段设置
└ options	option\[\]	选项
└ guid	string	选项的GUID
└ name	string	选项名称，不能为空，最大50个字符
└ color_index	int	选项的颜色索引值，可以是0～54中的一个数字。如果不填写则会随机选一个。
└ is_hidden	boolean	选项是否隐藏。隐藏后的选项在界面不可见，也不可以再通过openapi将字段值设为该选项。
└ multi_select_setting	select_setting	多选类型的字段设置
└ options	option\[\]	选项
└ guid	string	选项的GUID
└ name	string	选项名称，不能为空，最大50个字符
└ color_index	int	选项的颜色索引值，可以是0～54中的一个数字。如果不填写则会随机选一个。
└ is_hidden	boolean	选项是否隐藏。隐藏后的选项在界面不可见，也不可以再通过openapi将字段值设为该选项。
└ creator	member	创建人
└ id	string	表示member的id
└ type	string	成员的类型
└ role	string	成员角色
└ created_at	string	自定义字段创建的时间戳(ms)
└ updated_at	string	自定义字段的更新时间戳(ms)
└ text_setting	text_setting	文本字段配置
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "guid": "34d4b29f-3d58-4bc5-b752-6be80fb687c8",
                "name": "优先级",
                "type": "number",
                "number_setting": {
                    "format": "normal",
                    "custom_symbol": "自定义符号",
                    "custom_symbol_position": "left",
                    "separator": "thousand",
                    "decimal_count": 2
                },
                "member_setting": {
                    "multi": true
                },
                "datetime_setting": {
                    "format": "yyyy/mm/dd"
                },
                "single_select_setting": {
                    "options": [
                        {
                            "guid": "4216f79b-3fda-4dc6-a0c4-a16022e47152",
                            "name": "高优",
                            "color_index": 1,
                            "is_hidden": false
                        }
                    ]
                },
                "multi_select_setting": {
                    "options": [
                        {
                            "guid": "4216f79b-3fda-4dc6-a0c4-a16022e47152",
                            "name": "高优",
                            "color_index": 1,
                            "is_hidden": false
                        }
                    ]
                },
                "creator": {
                    "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "type": "user",
                    "role": "editor"
                },
                "created_at": "1688196600000",
                "updated_at": "1688196600000",
                "text_setting": {}
            }
        ],
        "page_token": "aWQ9NzEwMjMzMjMxMDE=",
        "has_more": false
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1470400	参数错误，如page_size填写一个负数。	错误原因见返回的msg提示的信息。
404	1470404	要访问的resource不存在或已删除。	确认要访问的resource不存在或已删除。
500	1470500	服务器错误。	尝试重试调用。如持续失败，请联系支持人员进行反馈。