GET
/
custom
/
attributes
/
users
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/custom/attributes/users' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

[
{
    "id": 1,
    "name": "Department",
    "type": 3,
    "apiId": "department",
    "position": 1,
    "isRequired": true,
    "extraData": [
{
    "id": 1,
    "position": 1,
    "value": "Sales"
},
{
    "id": 2,
    "position": 2,
    "value": "Marketing"
},
{
    "id": 3,
    "position": 3,
    "value": "Engineering"
}
    ],
    "isEditable": true
},
{
    "id": 2,
    "name": "Employee ID",
    "type": 1,
    "apiId": "employee_id",
    "position": 2,
    "isRequired": true,
    "extraData": null,
    "isEditable": true
}
]

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

curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/custom/attributes/users' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

[
{
    "id": 1,
    "name": "Department",
    "type": 3,
    "apiId": "department",
    "position": 1,
    "isRequired": true,
    "extraData": [
{
    "id": 1,
    "position": 1,
    "value": "Sales"
},
{
    "id": 2,
    "position": 2,
    "value": "Marketing"
},
{
    "id": 3,
    "position": 3,
    "value": "Engineering"
}
    ],
    "isEditable": true
},
{
    "id": 2,
    "name": "Employee ID",
    "type": 1,
    "apiId": "employee_id",
    "position": 2,
    "isRequired": true,
    "extraData": null,
    "isEditable": true
}
]