crm.board
Quadro Kanban de uma pipeline. Pipeline, cards por etapa (cards[stageId], em ordem) e totais por etapa (count, valueCents). q filtra por título, nome ou telefone do contato. Só traz cards de contatos que o chamador pode ver.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/crm.board(corpo JSON) - Quem pode chamar: membro da conta
- Escopo da chave:
crm:read - Grava dados: não
- Pela chave de API: sim
- Ferramenta MCP:
crm_board - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdcrm.board)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
pipelineId | string (uuid) | sim | |
q | string | não |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"pipelineId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"q": {
"type": "string",
"maxLength": 120
}
},
"required": [
"pipelineId"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/crm.board \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"pipelineId":"00000000-0000-0000-0000-000000000000"}'CLI:
node cli/atomiks.mjs crm.board --json '{"pipelineId":"00000000-0000-0000-0000-000000000000"}'MCP: ferramenta crm_board com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"pipeline": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"groupName": {
"type": [
"string",
"null"
]
},
"isDefault": {
"type": "boolean"
},
"stages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"open",
"won",
"lost"
]
},
"position": {
"type": "number"
},
"capiEvent": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"kind",
"position",
"capiEvent"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"groupName",
"isDefault",
"stages"
],
"additionalProperties": false
},
"cards": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"pipelineId": {
"type": "string"
},
"stageId": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"open",
"won",
"lost"
]
},
"title": {
"type": "string"
},
"valueCents": {
"type": [
"number",
"null"
]
},
"product": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"contact": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"phone"
],
"additionalProperties": false
},
"owner": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"openTasks": {
"type": "number"
},
"updatedAt": {
"type": "string"
},
"priority": {
"anyOf": [
{
"type": "string",
"enum": [
"low",
"normal",
"high",
"urgent"
]
},
{
"type": "null"
}
]
},
"expectedCloseDate": {
"type": [
"string",
"null"
]
},
"probability": {
"type": [
"number",
"null"
]
},
"origin": {
"type": [
"string",
"null"
]
},
"lostReason": {
"type": [
"string",
"null"
]
},
"company": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"pipelineId",
"stageId",
"status",
"title",
"valueCents",
"product",
"contact",
"owner",
"openTasks",
"updatedAt",
"priority",
"expectedCloseDate",
"probability",
"origin",
"lostReason",
"company"
],
"additionalProperties": false
}
}
},
"totals": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"valueCents": {
"type": "number"
}
},
"required": [
"count",
"valueCents"
],
"additionalProperties": false
}
},
"nextTasks": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"dueAt": {
"type": [
"string",
"null"
]
},
"kind": {
"type": "string"
},
"assignee": {
"type": [
"string",
"null"
]
}
},
"required": [
"title",
"dueAt",
"kind",
"assignee"
],
"additionalProperties": false
}
}
},
"required": [
"pipeline",
"cards",
"totals"
],
"additionalProperties": false
}Erros
{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).