CRM API Overview
The CekatAI CRM API allows you to manage your sales pipelines, deals, and customer relationships programmatically.
Base URL
Base URL: https://api.cekat.ai/api/crm
All CRM endpoints are prefixed with /api/crm.
Key Concepts
| Concept | Description |
|---|---|
| Board | A pipeline or process (e.g., "DEALS", "Partners", "Marketing") |
| Column | A stage in the pipeline (e.g., "Lead", "Qualified", "Closed") |
| Item | An individual record in the pipeline (e.g., a deal, a partner) |
List Boards
GET/api/crm/boards
Retrieve all CRM boards.
bash
curl -X GET "https://api.cekat.ai/api/crm/boards" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
200 OK
{
"message": "success",
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "DEALS",
"column_name": "Deal",
"item_display": "modal",
"icon": "Handshake",
"visibility": "public",
"type": "board",
"position": 19990,
"created_at": "2025-08-20T15:50:00.709132+00:00",
"updated_at": "2026-03-30T05:45:21.434+00:00",
"business_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Partners",
"column_name": "Partner",
"item_display": "modal",
"icon": "Users",
"visibility": "public",
"type": "board",
"position": 60000
}
]
}
Board Object
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique board identifier |
name | string | Board display name |
column_name | string | Singular name for items (e.g., "Deal") |
item_display | string | Display mode: modal |
icon | string | Icon name |
visibility | string | public or restricted |
type | string | Board type |
position | integer | Sort position |
created_at | string | Creation timestamp |
updated_at | string | Last update timestamp |
business_id | string | Business account ID |
Code Examples
javascript
const CRM_API = 'https://api.cekat.ai/api/crm';
const getBoards = async () => {
const response = await fetch(`${CRM_API}/boards`, {
headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});
return response.json();
};
const getBoardItems = async (boardId) => {
const response = await fetch(`${CRM_API}/boards/${boardId}/items`, {
headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});
return response.json();
};
// List all boards
const boards = await getBoards();
console.log(`Found ${boards.data.length} boards`);
// Get items from first board
const items = await getBoardItems(boards.data[0].id);