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

[
{
    "id": 1,
    "name": "Region",
    "type": 3,
    "apiId": "region",
    "position": 1,
    "isRequired": true,
    "extraData": [
{
    "id": 1,
    "position": 1,
    "value": "North America"
},
{
    "id": 2,
    "position": 2,
    "value": "Europe"
},
{
    "id": 3,
    "position": 3,
    "value": "Asia Pacific"
}
    ]
},
{
    "id": 2,
    "name": "Budget Center",
    "type": 1,
    "apiId": "budget_center",
    "position": 2,
    "isRequired": true,
    "extraData": null
},
{
    "id": 3,
    "name": "Active",
    "type": 6,
    "apiId": "is_active",
    "position": 3,
    "isRequired": false,
    "extraData": null
}
]

Retrieve all custom attributes configured for groups 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

​
Notes on Attribute Types

  • Text (type 1): Single-line text input
  • Date (type 2): Date selector
  • Single Choice (type 3): Dropdown with single selection
  • Multiple Choice (type 4): Checkbox list with multiple selections
  • User Choice (type 5): User selector
  • Yes/No (type 6): Boolean toggle
  • External Link (type 7): URL input
  • Number (type 8): Numeric input
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/custom/attributes/groups' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

[
{
    "id": 1,
    "name": "Region",
    "type": 3,
    "apiId": "region",
    "position": 1,
    "isRequired": true,
    "extraData": [
{
    "id": 1,
    "position": 1,
    "value": "North America"
},
{
    "id": 2,
    "position": 2,
    "value": "Europe"
},
{
    "id": 3,
    "position": 3,
    "value": "Asia Pacific"
}
    ]
},
{
    "id": 2,
    "name": "Budget Center",
    "type": 1,
    "apiId": "budget_center",
    "position": 2,
    "isRequired": true,
    "extraData": null
},
{
    "id": 3,
    "name": "Active",
    "type": 6,
    "apiId": "is_active",
    "position": 3,
    "isRequired": false,
    "extraData": null
}
]