> For the complete documentation index, see [llms.txt](https://docs.cekat.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cekat.ai/api-documentation/crm/board/get-a-crm-board.md).

# Get a CRM board

Returns a board with its groups and columns, in display order. Use it to find column names, types, and select options before reading or writing items.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"Board","description":"A board is a custom CRM table, such as a deals pipeline. It has **groups** (sections), **columns** (fields), and **items** (rows).\n\n## Item values\nWhen you create or update an item, send each column value as a top-level field named after the column, for example `{\"item_name\": \"Deal A\", \"Status\": \"1\", \"Amount\": 2500000}`. Get column names, types and select options from `GET /api/crm/boards/{id}`.\n\n| Column type | Value format |\n| --- | --- |\n| `text`, `long_text`, `phone` | String |\n| `email` | Email address string |\n| `number` | Number (numeric strings are accepted) |\n| `date` | ISO 8601 date-time with time zone, for example `2026-10-20T09:00:00+07:00` |\n| `timeline` | `{\"from\": \"<ISO date-time>\", \"to\": \"<ISO date-time>\"}` |\n| `checkbox` | `true` or `false` |\n| `select` | One label `id` from the column's `settings.labels` |\n| `dropdown` | Array of label `id`s from the column's `settings.labels` |\n| `agents` | Array of agent IDs |\n| `contacts`, `companies`, `orders`, `subscriptions`, `references` | Array of IDs of those records |\n| `conversation` | Conversation ID |\n| `files` | Array of `{\"file_name\", \"file_url\", \"file_type\"}` objects |\n\nA value that fails validation does not fail the whole request: the item is still saved, `message` is `success_with_failures`, and each rejected value is listed in `failed`.\n"}],"servers":[{"url":"https://api.cekat.ai","description":"Production"}],"security":[{"CekatApiKey":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"CekatApiKey":{"type":"apiKey","in":"header","name":"api_key","description":"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."},"BearerAuth":{"type":"http","scheme":"bearer","description":"The same Cekat API key, sent as `Authorization: Bearer YOUR_API_KEY`. Accepted only by endpoints under `/api/...`."}},"schemas":{"CrmBoardDetail":{"allOf":[{"$ref":"#/components/schemas/CrmBoard"},{"type":"object","properties":{"crm_groups":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CrmGroup"}},"crm_columns":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CrmColumn"}},"crm_board_views":{"type":"array","nullable":true,"items":{"type":"object","additionalProperties":true}},"agent_ids":{"type":"array","description":"Agents the board is shared with.","items":{"$ref":"#/components/schemas/NamedRef"}},"role_ids":{"type":"array","description":"Roles the board is shared with.","items":{"$ref":"#/components/schemas/NamedRef"}}}}]},"CrmBoard":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"business_id":{"type":"string","format":"uuid"},"icon":{"type":"string","nullable":true},"item_display":{"type":"string","nullable":true},"column_name":{"type":"string","description":"Label used for the item name column, for example `Item` or `Deal`."},"visibility":{"type":"string","enum":["public","private","restricted"]},"position":{"type":"number"},"type":{"type":"string"},"created_by":{"nullable":true,"description":"The board's creator. An agent ID in the board list, and an object with `id` and `name` in the board details."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}},"CrmGroup":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"board_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string","nullable":true},"position":{"type":"number"},"created_at":{"type":"string","format":"date-time"}}},"CrmColumn":{"type":"object","description":"A board column (field) or contact property.","additionalProperties":true,"properties":{"id":{"type":"string","format":"uuid"},"board_id":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string","enum":["text","long_text","email","phone","number","timeline","date","checkbox","select","dropdown","file","files","reference","references","agents","contacts","conversation","order","orders","companies","subscriptions","item_deals"]},"settings":{"type":"object","additionalProperties":true,"description":"Type-specific settings. `select` and `dropdown` columns list their options in `labels`.","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/CrmColumnLabel"}}}},"default_value":{"type":"string","nullable":true},"is_required":{"type":"boolean"},"is_visible":{"type":"boolean"},"is_unique":{"type":"boolean"},"read_only":{"type":"boolean"},"position":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}},"CrmColumnLabel":{"type":"object","properties":{"id":{"type":"string","description":"Label ID. Use it as the value for `select` and `dropdown` columns."},"name":{"type":"string"},"color":{"type":"string"}}},"NamedRef":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}},"ApiError":{"type":"object","description":"Error body returned by the `/api/...` endpoints.","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"statusCode":{"type":"integer"},"error":{"type":"object","properties":{"message":{"type":"string"}}},"correlationId":{"type":"string","description":"Request ID. Include it when contacting Cekat support."}}},"RateLimitError":{"type":"object","properties":{"message":{"type":"string"}}}},"responses":{"ApiUnauthorized":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"ApiNotFound":{"description":"The resource was not found or does not belong to your business.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"TooManyRequests":{"description":"Rate limit exceeded. Wait and retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitError"}}}}}},"paths":{"/api/crm/boards/{boardId}":{"get":{"tags":["Board"],"operationId":"GetCrmBoard","summary":"Get a CRM board","description":"Returns a board with its groups and columns, in display order. Use it to find column names, types, and select options before reading or writing items.","parameters":[{"name":"boardId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The board.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/CrmBoardDetail"}}}}}},"401":{"$ref":"#/components/responses/ApiUnauthorized"},"404":{"$ref":"#/components/responses/ApiNotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}}}}
```