User attributes

get

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Query parameters

afterstringOptional

limitnumberOptional

Responses

200Success

application/json

and

get

/v1/user-attributes

HTTPcURLJavaScriptPython

GET /v1/user-attributes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "paging": {
    "next": {
      "after": "text"
    }
  },
  "data": [
    {
      "id": "text",
      "name": "text",
      "label": "text",
      "type": "STRING",
      "allow_multiple_values": true
    }
  ]
}

get

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

userAttributeIdstringRequired

Responses

200Success

application/json

idstringRequired

Unique ID

namestringRequired

Name of User Attribute

labelstringRequired

Human friendly label for User Attribute

typestring · enumRequired

Type of the User Attribute

Possible values:

allow_multiple_valuesbooleanRequired

If true, a User can have multiple values for this User Attribute

get

/v1/user-attributes/{userAttributeId}

HTTPcURLJavaScriptPython

GET /v1/user-attributes/{userAttributeId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "text",
  "name": "text",
  "label": "text",
  "type": "STRING",
  "allow_multiple_values": true
}