Skip to content
Dixa API/
/
Get custom attribute defi...

Get custom attribute definition by id

Request

Get custom attribute in an organization by id.

Security
ApiKeyAuth
Path
customAttributeIdstringrequired
GET
/v1/custom-attributes/{customAttributeId}
curl -i -X GET \
  'https://dev.dixa.io/v1/custom-attributes/{customAttributeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The configured custom attribute

Bodyapplication/json
dataobject(CustomAttributeDefinition)required
Response
{
  "data": {
    "id": "db5f673b-1c40-41e7-b71f-caab342f0607",
    "entityType": "Conversation",
    "identifier": "contact_reason",
    "label": "Contact Reason",
    "inputDefinition": { … },
    "description": "Reason for contacting",
    "createdAt": "2023-01-05T06:42:31.532Z[GMT]",
    "isRequired": true,
    "isArchived": false,
    "isDeactivated": false
  }
}