Skip to main content
GET
Retrieve all custom attributes configured for users on your platform.

Request Headers

X-API-KEY
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.

Response

Array of custom attribute objects with the following properties:
id
integer
required
Attribute ID
name
string
required
Attribute name
type
integer
required
Attribute type:
  • 1: text
  • 2: date
  • 3: single choice
  • 4: multiple choice
  • 5: user choice
  • 6: yes/no
  • 7: external link
  • 8: number
apiId
string
required
Attribute API identifier
position
integer
required
Display position order
isRequired
boolean
required
Whether the attribute is mandatory
extraData
array
Additional data for choice-type attributes
isEditable
boolean
required
Whether the attribute can be modified