Boards API
Retrieve information about your CRM boards (pipelines).
List Boards
GET/api/crm/boards
Retrieve all CRM boards in your workspace.
bash
curl -X GET "https://api.cekat.ai/api/crm/boards" \
-H "Authorization: Bearer YOUR_API_KEY"
Query Parameters
limitinteger
Results per page (default: 50)
offsetinteger
Pagination offset
Response
200 OK
{
"success": true,
"data": [
{
"id": "board_abc123",
"name": "Sales Pipeline",
"description": "Main sales pipeline for B2B leads",
"columns_count": 5,
"items_count": 127,
"created_at": "2025-01-15T08:00:00Z",
"updated_at": "2025-03-27T14:30:00Z"
},
{
"id": "board_def456",
"name": "Support Queue",
"description": "Customer support ticket queue",
"columns_count": 4,
"items_count": 45,
"created_at": "2025-02-01T10:00:00Z",
"updated_at": "2025-03-27T16:00:00Z"
}
],
"pagination": {
"total": 8,
"limit": 50,
"offset": 0
}
}
Get Board
GET/api/crm/boards/:id
Retrieve a single board with full details including columns.
bash
curl -X GET "https://api.cekat.ai/api/crm/boards/board_abc123" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
200 OK
{
"success": true,
"data": {
"id": "board_abc123",
"name": "Sales Pipeline",
"description": "Main sales pipeline for B2B leads",
"columns": [
{
"id": "col_001",
"name": "Lead",
"position": 0,
"items_count": 42
},
{
"id": "col_002",
"name": "Qualified",
"position": 1,
"items_count": 35
},
{
"id": "col_003",
"name": "Proposal",
"position": 2,
"items_count": 28
},
{
"id": "col_004",
"name": "Negotiation",
"position": 3,
"items_count": 15
},
{
"id": "col_005",
"name": "Closed Won",
"position": 4,
"items_count": 7
}
],
"settings": {
"allow_delete": true,
"allow_reorder": true,
"color": "#2F6FD6"
},
"created_at": "2025-01-15T08:00:00Z",
"updated_at": "2025-03-27T14:30:00Z"
}
}
Board Object
| Field | Type | Description |
|---|---|---|
id | string | Unique board identifier |
name | string | Board display name |
description | string | Board description |
columns | array | Array of column objects (full board GET only) |
columns_count | integer | Total columns |
items_count | integer | Total items across all columns |
settings | object | Board configuration |
created_at | string | Creation timestamp |
updated_at | string | Last update timestamp |
Code Examples
javascript
const getBoards = async () => {
const response = await fetch('https://api.cekat.ai/api/crm/boards', {
headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});
return response.json();
};
const getBoard = async (boardId) => {
const response = await fetch(
`https://api.cekat.ai/api/crm/boards/${boardId}`,
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
return response.json();
};
// List all boards
const boards = await getBoards();
console.log(`Found ${boards.data.length} boards`);
// Get specific board with columns
const board = await getBoard('board_abc123');
board.data.columns.forEach(col => {
console.log(`${col.name}: ${col.items_count} items`);
});