Skip to content

获取自定义用户属性

适用版本>=v7.0.2412a.20241212

接口说明:获取自定义用户属性列表

请求说明

请求地址配置域名+/openapi+/v7/companies/user_custom_attrs/batch_read
请求方法GET
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询和管理用户自定义字段(应用授权) kso.user_custom_attr.readwrite

请求头(Header)

Header参数类型是否必填说明
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

响应体(Response)

名称类型说明
codeint错误码
detailstring详细信息
msgstring状态信息
dataobject返回信息体
custom_attrsobject[]自定义属性列表
idstring自定义属性 id
namestring自定义属性名称
optionstring自定义字段 type 为 option 时,展示的选项列表
keystringkey 值, 修改 / 新增时作为入参值
namestring显示名
value_typestring自定义属性值类型
totalinteger总数

响应体示例

json
{
  "data": {
    "custom_attrs": [
      {
        "id": "string",
        "name": "string",
        "options": [
          {
            "key": "string",
            "name": "string"
          }
        ],
        "value_type": "text"
      }
    ],
    "total": 0
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}