Referência da API
Especificação técnica completa de cada endpoint, parâmetros, schemas e códigos de erro.
Especificação técnica completa. Para tutoriais passo a passo, veja Começar. Para casos de uso, veja Guias.
Convenções gerais
Autenticação
Bearer API key, escopos, security scheme OpenAPI.
Códigos de erro
Lista completa, formato, códigos HTTP e estratégia de retry.
Endpoints disponíveis
Contatos
GET /contacts
Listar contatos com busca livre, filtros exatos e sync incremental por data. Beta.
GET /contacts/{id}
Obter um contato único por UUID. Beta.
POST /contacts
Criar ou atualizar contato (upsert) por email ou telefone, com UTMs e campos personalizados. Beta.
GET /contacts/message-search
Buscar contatos por termos mencionados em mensagens. Beta.
Negócios
GET /deals
Listar negócios com filtros por pipeline, etapa, responsável, contato, status e external_id. Beta.
GET /deals/{id}
Obter um negócio único por UUID. Beta.
POST /deals
Criar negócio em uma etapa do pipeline, vinculando ou criando o contato, com idempotência por external_id. Beta.
Funis e equipe
GET /pipelines
Listar funis com suas etapas em ordem. Beta.
GET /members
Listar a equipe para resolver o responsável de negócios e conversas. Beta.
Conversas
GET /conversations
Listar conversas com contato, canal, situação, responsável e última atividade. Beta.
GET /conversations/{id}/messages
Ler o texto das mensagens de uma conversa. Beta.
Campanhas e automações
GET /campaigns
Listar campanhas de disparo com situação, modelo, canal e contadores acumulados. Beta.
GET /automations
Listar automações com gatilho, situação e uso, sem o fluxo. Beta.
Tarefas, notas e agendamentos
GET /tasks
Listar tarefas da equipe com responsável e vínculos com negócio, contato e conversa. Beta.
POST /tasks
Criar uma tarefa para a equipe, vinculada a negócio, contato ou conversa. Beta.
POST /tasks/{id}/complete
Concluir uma tarefa em nome de quem criou a chave. Beta.
POST /notes
Registrar uma nota interna em um contato ou negócio, visível só para a equipe. Beta.
GET /appointments
Listar agendamentos da agenda com profissional, serviço e dados de quem agendou. Beta.
Formulários
GET /forms
Listar formulários com contadores e perguntas. Beta.
GET /forms/{id}/responses
Listar as respostas de um formulário, sem as de teste. Beta.
Relatórios
GET /analytics/reports/funnel
Entradas, saídas e tempo por etapa, e envelhecimento dos negócios abertos. Beta.
GET /analytics/reports/service
SLA atual, mensagens por dia e por canal, CSAT e NPS. Beta.
GET /analytics/reports/dispatch
Campanhas iniciadas, entrega por dia e por canal e custo em dólar. Beta.
GET /analytics/reports/operations
Agendamentos, tarefas, respostas de formulários e execuções de automações. Beta.
Mensagens
Outros endpoints estão sob avaliação. Quando publicados, serão listados aqui automaticamente.
Base URL
- Produção (canônica, versionada):
https://crm.oficinamartech.com/api/v1 - Alias legado (sem versão):
https://crm.oficinamartech.com/api— pode continuar funcionando, mas não é contrato para integrações novas.
Formato
- Request: query params (GET) ou JSON body (POST/PUT) com UTF-8
- Response: JSON com
Content-Type: application/json - Timestamps: ISO 8601 com timezone (
2026-05-20T13:24:00.000Z) - IDs: UUID v4 (
f47ac10b-58cc-4372-a567-0e02b2c3d479)