获取企业自定义用户字段

GET

/open-apis/contact/v3/custom_attrs

自建应用商店应用

获取企业自定义的用户字段配置信息
调用该接口前，需要先确认企业管理员在企业管理后台 - 组织架构 - 成员字段管理自定义字段管理栏开启了“允许开放平台API调用“。

错误码

HTTP状态码	错误码	描述	排查建议
400	40012	page token is invalid error	page token无效。
400	40011	page size is invalid	无效的分页参数

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/contact/v3/custom_attrs' \
--header 'Authorization;'

响应示例

{
  "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
  }
}

请求参数

Query 参数

page_size

可选

分页大小示例值：10 数据校验规则：最大值：100

示例值:

page_token

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值："AQD9/Rn9eij9Pm39ED40/RYU5lvOM4s6zgbeeNNaWd+VKwAsoreeRWk0J2noGvJy"

示例值:

AQD9/Rn9eij9Pm39ED40/RYU5lvOM4s6zgbeeNNaWd+VKwAsoreeRWk0J2noGvJy

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

items

array [object {4}]

自定义字段定义

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

has_more

boolean

是否还有更多项

必需

修改于 2023-01-12 04:03:49

成员字段变更

资源介绍

获取企业自定义用户字段

错误码#

请求参数

返回响应

错误码