v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB

Contacts

List contact attributes

Returns a list of all available contact attributes and their configurations.

get/contact/contacts/attributes

Response

Successfully retrieved contact attributes.

idstring required

Unique identifier for the contact attribute.

namestring required

Display name of the contact attribute.

keystring required

Key name used to reference this attribute.

type'BOOLEAN' | 'TEXT' | 'TIME' | 'ARRAY' required

Data type of the contact attribute.

descstring

Description of the contact attribute.

valuesstring[]

Array of possible values for this attribute. Only present when type is "ARRAY".

Example response

[
  {
    "id": "6865e6c17c3854485be550b0",
    "name": "Blocked",
    "key": "blocked",
    "type": "BOOLEAN",
    "desc": "",
    "values": []
  }
]