ReferênciaAutomações
Listar automações
GET /automations — lista as automações da organização com gatilho, situação e uso, sem o fluxo.
GET
/automationsBetaEscopo necessário: analytics:read
Lista as automações da organização (resolvida pela API key), da mais recente para a mais antiga (created_at decrescente). Cada linha traz identificação, gatilho e uso. O fluxo da automação nunca é devolvido.
Endpoint
GET https://crm.oficinamartech.com/api/v1/automationsParâmetros de query
| Parâmetro | Tipo | Descrição |
|---|---|---|
is_active | true | false | true devolve só as ativas; false, só as pausadas. |
limit | int (1-100) | Tamanho da página. Default: 50. |
offset | int (0-10000) | Deslocamento da página. Default: 0. |
Um parâmetro fora desta lista é recusado com 400.
A paginação informa has_more e next_offset, sem total. offset vai até 10.000; além disso next_offset vem null mesmo com has_more true. A resposta usa Cache-Control: private, no-store.
Exemplo
curl -s "https://crm.oficinamartech.com/api/v1/automations?is_active=true&limit=1" \
-H "Authorization: Bearer crm_live_SEU_PREFIXO_SEU_SEGREDO"Resposta 200
{
"data": [
{
"id": "a07a07a0-58cc-4372-a567-0e02b2c3d479",
"name": "Boas-vindas a novos leads",
"description": "Envia a primeira mensagem quando o contato é criado.",
"trigger_type": "contact_created",
"is_active": true,
"execution_count": 342,
"last_executed_at": "2026-11-12T18:20:11.000Z",
"created_at": "2026-10-01T13:00:00.000Z",
"updated_at": "2026-11-05T09:30:00.000Z"
}
],
"pagination": {
"limit": 1,
"offset": 0,
"has_more": true,
"next_offset": 1
}
}description e last_executed_at são null quando não há descrição ou a automação nunca executou.
Erros
| Status | Código | Quando |
|---|---|---|
400 | invalid_query | Query inválida (parâmetro desconhecido, valor de is_active diferente de true/false, limit ou offset fora da faixa). |
401 | missing_api_key / invalid_api_key | API key ausente, inválida, expirada ou revogada. |
403 | missing_scope | A chave não tem o escopo analytics:read. |
429 | rate_limited | Acima de 120 req/min por chave ou por organização. |
500 | — | Erro interno. |