For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get contact properties

Lists the custom properties (columns) that can be set on the contact, with each one's id, type and options. Use the id and type when updating values. The contact's current values are in crm_column from GET /api/crm/contact/{contact_id}.

get
Authorizations
api_keystringRequired

Your business's Cekat API key, from Settings → Developers & API in the Cekat dashboard (https://chat.cekat.ai/developers?section=apikeys). Available on the Business and Enterprise plans.

Path parameters
idstring · uuidRequired

Contact ID.

Responses
200

Contact property definitions.

application/json
messagestringOptional
get/api/crm/contact/{id}/property
GET /api/crm/contact/{id}/property HTTP/1.1
Host: api.cekat.ai
api_key: YOUR_API_KEY
Accept: */*
{
  "message": "success",
  "data": [
    {
      "id": "7a6b5c4d-3e2f-4a1b-8c9d-0e1f2a3b4c5d",
      "board_id": "3b2a1c0d-9e8f-4a7b-6c5d-4e3f2a1b0c9d",
      "name": "Customer tier",
      "type": "select",
      "settings": {
        "labels": [
          {
            "id": "0",
            "name": "Gold",
            "color": "#FFCB00"
          }
        ]
      },
      "is_required": false,
      "is_visible": true,
      "is_unique": false,
      "read_only": false,
      "position": 12
    }
  ]
}

Last updated