§docsReferência da API

API REST do consultor.app

Integre o consultor.app com seus sistemas. Todos os endpoints usam JSON, autenticação via API key e retornam erros padronizados.

Autenticação

Todas as requisições devem incluir o header Authorization: Bearer <API_KEY>.

Gere sua API key em Configurações → API → Nova chave. Cada chave tem escopo configurável (leitura, escrita ou ambos).

# Exemplo de requisição

curl https://api.consultor.app/v1/clients \

-H "Authorization: Bearer ck_live_..."

GET/v1/clientsLista todos os clientes do workspace

POST/v1/clientsCria um novo cliente

GET/v1/clients/:idRetorna um cliente pelo ID

PATCH/v1/clients/:idAtualiza dados de um cliente

DELETE/v1/clients/:idRemove um cliente

GET/v1/projectsLista todos os projetos

POST/v1/projectsCria um novo projeto

GET/v1/projects/:idRetorna um projeto pelo ID

POST/v1/reportsSolicita geração de relatório

GET/v1/reports/:idRetorna o status e conteúdo de um relatório

GET/v1/workflowsLista workflows configurados

POST/v1/workflows/:id/triggerDispara um workflow manualmente

Configure uma URL de destino em Configurações → API → Webhooks. O consultor.app envia um POST com payload JSON para cada evento.

client.createdNovo cliente adicionado ao CRM

client.updatedDados de cliente atualizados

project.status_changedStatus de projeto alterado

report.readyRelatório gerado e pronto para revisão

meeting.processedReunião transcrita e organizada

workflow.completedWorkflow concluído com sucesso

proposal.approvedProposta aprovada pelo consultor

Consultor

1.000 req/hora

Enterprise

Sob medida

Webhooks

Sem limite de recebimento