Desenvolvedores
API, servidor MCP e linha de comando do Sirius CRM
O Sirius CRM tem três portas para quem quer ler e escrever no CRM por código: a API REST v1, com chave de API; o servidor MCP, para Claude, ChatGPT, Cursor e outros agentes agirem em nome de uma pessoa da conta; e uma linha de comando. Tudo vale para a conta de uma empresa e enxerga só os dados dela.
Autenticação da API REST
A API usa uma chave por empresa. Crie a chave logado, em Configurações → API (/dashboard/settings/api). Ela começa com sk_live_, aparece uma única vez e pode ser revogada na mesma tela. Guarde-a em uma variável de ambiente, nunca no código.
Envie a chave em todo pedido, no cabeçalho Authorization: Bearer <chave>. Sem ela, ou com uma chave inválida ou revogada, a resposta é 401. A base é https://siriuscrm.com.br/api/v1. O acesso à API depende do plano da conta.
Endpoints
Todos sob https://siriuscrm.com.br/api/v1. Listas aceitam page, limit (até 100), sortBy e order.
| Métodos | Caminho | O que faz |
|---|---|---|
| GET, POST | /contacts | Listar e criar contatos |
| GET, PATCH, DELETE | /contacts/{id} | Ver, atualizar e apagar um contato |
| GET, POST | /deals | Listar e criar negócios |
| GET, PATCH, DELETE | /deals/{id} | Ver, atualizar e apagar um negócio |
| GET, POST | /pipelines | Listar e criar funis, com as etapas |
| GET | /pipelines/{id} | Ver um funil |
| GET | /analytics/overview | Números gerais de vendas |
| GET, POST | /webhooks | Listar e criar webhooks de eventos |
| GET, PATCH, DELETE | /webhooks/{id} | Ver, atualizar e apagar um webhook |
| GET | /webhooks/{id}/logs | Histórico de entregas de um webhook |
A especificação completa, com os campos de cada pedido e resposta, está em OpenAPI 3.1: /api/openapi.json. A referência interativa fica em /api/docs.
Exemplos de requisição
Listar contatos:
curl -sS "https://siriuscrm.com.br/api/v1/contacts?page=1&limit=20" \
-H "Authorization: Bearer $SIRIUS_API_KEY"Criar um contato (name é obrigatório; email, phone e company, opcionais):
curl -sS -X POST "https://siriuscrm.com.br/api/v1/contacts" \
-H "Authorization: Bearer $SIRIUS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Ana Souza","email":"ana@exemplo.com.br","phone":"5562999990000","company":"Exemplo Ltda"}'Toda resposta de sucesso traz success: true, os dados em data, o meta.requestId (cite-o ao falar com o suporte) e, nas listas, pagination:
{
"success": true,
"data": [
{
"id": "…",
"name": "Ana Souza",
"email": "ana@exemplo.com.br",
"phone": "5562999990000",
"company": "Exemplo Ltda",
"dealsCount": 0,
"createdAt": "2026-10-31T15:00:00.000Z",
"updatedAt": "2026-10-31T15:00:00.000Z"
}
],
"meta": { "requestId": "…", "timestamp": "2026-10-31T15:00:00.000Z" },
"pagination": { "page": 1, "limit": 20, "total": 1, "totalPages": 1, "hasNext": false, "hasPrev": false }
}Erros trazem success: false e um error.code:
{
"success": false,
"error": { "code": "UNAUTHORIZED", "message": "Invalid or expired API key" },
"meta": { "requestId": "…", "timestamp": "2026-10-31T15:00:00.000Z" }
}Cada resposta informa o limite de pedidos por minuto em X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset. Passou do limite, a resposta é 429 com Retry-After, em segundos.
Servidor MCP para agentes de IA
O servidor MCP fica em https://siriuscrm.com.br/api/mcp (Streamable HTTP, só POST, respostas em JSON). Cada pessoa da conta conecta a própria IA e ela enxerga só o que a pessoa enxerga. No Claude Code:
claude mcp add --transport http sirius https://siriuscrm.com.br/api/mcpA autorização é OAuth 2.1 com PKCE e registro dinâmico de clientes: sem token, o servidor responde 401 com WWW-Authenticate apontando para os metadados em /.well-known/oauth-protected-resource/api/mcp, e a pessoa aprova o acesso na tela do Sirius. Os escopos são crm:read (ler contatos, negócios, funis, atividades e conversas do WhatsApp) e crm:write (criar e atualizar registros, mover negócios e enviar mensagens). Quem libera só a leitura nem vê as ferramentas que escrevem. Para scripts e n8n, a pessoa pode criar um token pessoal em Configurações → Integrações → IA. O limite é de 120 chamadas por minuto por conexão.
A lista de ferramentas vem de tools/list na conexão. Para agentes, os documentos de descoberta: cartão do servidor MCP, auth.md, skill do Sirius CRM e llms.txt.