API v1.0.0145 operações documentadasAtualizado 2026-08-09

API REST da Eskadia

Conecte CRM, operações, finanças, RH, agentes de IA, edição audiovisual, compras, obras e webhooks aos seus aplicativos.

Baixar OpenAPI 3.1 Contexto para IA
URL base: https://app.eskadia.com/api/v1

Autenticação e limites

Token Bearer

Todas as rotas, exceto GET /health, exigem um token criado em Configurações → API.

Authorization: Bearer esk_live_...
Limites de uso
Leituras GET500/min
Operações gerais100/min
Escritas20/min
As solicitações POST aceitam Idempotency-Key para evitar duplicados durante 24 horas. As funções disponíveis são viewer, member, manager e admin.

Catálogo atual de endpoints

O catálogo é conferido com as rotas atuais do CRM e exclui módulos sem API pública.

Plataforma

Saúde do serviço, usuários, organizações, configurações e atividade.

GET/healthListar plataformaPúblico
GET/dashboardListar plataformamanager+
GET/reportsListar plataformamanager+
GET/settingsListar plataformaviewer+
PATCH/settingsAtualizar plataformaadmin+
GET/settings/deal-stagesListar plataformaviewer+
GET/settings/webhooksListar plataformaadmin+
PATCH/settings/webhooksAtualizar plataformaadmin+
POST/emails/sendCriar plataformamember+
POST/marketing/sendCriar plataformamember+
POST/production/notifyCriar plataformamember+

CRM e vendas

Contatos, empresas, leads, oportunidades, catálogo e promoções.

GET/contactsListar CRMviewer+
POST/contactsCriar CRMmember+
GET/contacts/{id}Consultar CRMviewer+
PATCH/contacts/{id}Atualizar CRMmember+
DELETE/contacts/{id}Excluir CRMadmin+
GET/companiesListar CRMviewer+
POST/companiesCriar CRMmember+
GET/companies/{id}Consultar CRMviewer+
PATCH/companies/{id}Atualizar CRMmember+
DELETE/companies/{id}Excluir CRMadmin+
GET/leadsListar CRMviewer+
POST/leadsCriar CRMmember+
GET/leads/{id}Consultar CRMviewer+
PATCH/leads/{id}Atualizar CRMmember+
DELETE/leads/{id}Excluir CRMadmin+
GET/dealsListar CRMviewer+
POST/dealsCriar CRMmember+
GET/deals/{id}Consultar CRMviewer+
PATCH/deals/{id}Atualizar CRMmember+
DELETE/deals/{id}Excluir CRMadmin+
GET/productsListar CRMviewer+
GET/products/{id}Consultar CRMviewer+
GET/quotesListar CRMviewer+
GET/quotes/{id}Consultar CRMviewer+
GET/promotionsListar CRMviewer+
POST/promotionsCriar CRMmember+
GET/promotions/{id}Consultar CRMviewer+
PATCH/promotions/{id}Atualizar CRMmember+
DELETE/promotions/{id}Excluir CRMadmin+
POST/promotions/validate-codeCriar CRMviewer+

Trabalho e suporte

Tarefas, projetos, atividade e tickets de suporte.

GET/tasksListar trabalhoviewer+
POST/tasksCriar trabalhomember+
GET/tasks/{id}Consultar trabalhoviewer+
PATCH/tasks/{id}Atualizar trabalhomember+
DELETE/tasks/{id}Excluir trabalhoadmin+
GET/projectsListar trabalhoviewer+
POST/projectsCriar trabalhomember+
GET/projects/{id}Consultar trabalhoviewer+
PATCH/projects/{id}Atualizar trabalhomember+
DELETE/projects/{id}Excluir trabalhoadmin+
GET/activitiesListar trabalhoviewer+
GET/activities/{id}Consultar trabalhoviewer+
GET/support/ticketsListar trabalhoviewer+
POST/support/ticketsCriar trabalhomember+
GET/support/tickets/{id}Consultar trabalhoviewer+
PATCH/support/tickets/{id}Atualizar trabalhomember+
DELETE/support/tickets/{id}Excluir trabalhoadmin+
GET/support/tickets/{id}/messagesConsultar trabalhoviewer+
POST/support/tickets/{id}/messagesExecutar operação de trabalhomember+

Agentes de IA

Agentes, execuções e recursos de inteligência artificial.

POST/ai/{feature}Criar IAmember+
GET/agentsListar IAviewer+
GET/agents/{type}Listar IAviewer+
POST/agents/{type}Criar IAmanager+
PATCH/agents/{type}Atualizar IAmanager+
GET/agents/suggestionsListar IAviewer+
PATCH/agents/suggestions/{id}Atualizar IAmanager+
GET/agents/logListar IAviewer+

Edição audiovisual

Fila de vídeos, atribuições, revisão e processamento.

GET/edicion/videosListar edição audiovisualviewer+
GET/edicion/videos/{id}Consultar edição audiovisualviewer+
PATCH/edicion/videos/{id}Atualizar edição audiovisualmember+
POST/edicion/videos/batchCriar edição audiovisualmember+
POST/edicion/videos/claimCriar edição audiovisualmember+

Finanças

Faturas, despesas, fluxo de caixa, orçamentos e análises.

GET/finance/invoicesListar finançasviewer+
POST/finance/invoicesCriar finançasmember+
GET/finance/invoices/{id}Consultar finançasviewer+
PATCH/finance/invoices/{id}Atualizar finançasmember+
DELETE/finance/invoices/{id}Excluir finançasadmin+
GET/finance/expensesListar finançasviewer+
POST/finance/expensesCriar finançasmember+
GET/finance/expenses/{id}Consultar finançasviewer+
PATCH/finance/expenses/{id}Atualizar finançasmember+
DELETE/finance/expenses/{id}Excluir finançasmember+
GET/finance/cashflowListar finançasviewer+
POST/finance/cashflowCriar finançasmember+
PATCH/finance/cashflowAtualizar finançasmember+
DELETE/finance/cashflowExcluir finançasmember+
GET/finance/budgetsListar finançasviewer+
POST/finance/budgetsCriar finançasmember+
PATCH/finance/budgetsAtualizar finançasmember+
DELETE/finance/budgetsExcluir finançasmember+

Recursos humanos

Funcionários, departamentos, ausências, presença e folha de pagamento.

GET/hr/employeesListar RHviewer+
POST/hr/employeesCriar RHmember+
GET/hr/employees/{id}Consultar RHviewer+
PATCH/hr/employees/{id}Atualizar RHmember+
DELETE/hr/employees/{id}Excluir RHadmin+
GET/hr/departmentsListar RHviewer+
POST/hr/departmentsCriar RHmember+
GET/hr/absencesListar RHviewer+
POST/hr/absencesCriar RHmember+
GET/hr/absences/{id}Consultar RHviewer+
PATCH/hr/absences/{id}Atualizar RHmember+
DELETE/hr/absences/{id}Excluir RHadmin+
GET/hr/attendanceListar RHviewer+
POST/hr/attendanceCriar RHmember+
GET/hr/payrollListar RHmanager+
GET/hr/payroll/{employeeId}Listar RHmanager+

Compras e obras

Fornecedores, pedidos, RFQs, recebimentos, contratos e ordens de trabalho.

GET/purchases/suppliersListar compras e obrasviewer+
GET/purchases/ordersListar compras e obrasviewer+
POST/purchases/ordersCriar compras e obrasmember+
GET/purchases/rfqListar compras e obrasviewer+
POST/purchases/rfqCriar compras e obrasmember+
GET/purchases/receiptsListar compras e obrasviewer+
POST/purchases/receiptsCriar compras e obrasmember+
GET/obras/lpu-itemsListar compras e obrasviewer+
POST/obras/lpu-itemsCriar compras e obrasmanager+
PATCH/obras/lpu-itemsAtualizar compras e obrasmanager+
DELETE/obras/lpu-itemsExcluir compras e obrasmanager+
GET/obras/client-contractsListar compras e obrasviewer+
POST/obras/client-contractsCriar compras e obrasmember+
PATCH/obras/client-contractsAtualizar compras e obrasmember+
DELETE/obras/client-contractsExcluir compras e obrasadmin+
GET/obras/subcontractor-contractsListar compras e obrasviewer+
POST/obras/subcontractor-contractsCriar compras e obrasmember+
PATCH/obras/subcontractor-contractsAtualizar compras e obrasmember+
DELETE/obras/subcontractor-contractsExcluir compras e obrasadmin+
GET/obras/work-ordersListar compras e obrasviewer+
POST/obras/work-ordersCriar compras e obrasmember+
PATCH/obras/work-ordersAtualizar compras e obrasmember+
DELETE/obras/work-ordersExcluir compras e obrasadmin+

Integrações e webhooks

Conexões, sincronização, testes e eventos de saída.

GET/integrationsListar integraçõesviewer+
GET/integrations/logsListar integraçõesviewer+
GET/integrations/{slug}Listar integraçõesviewer+
PATCH/integrations/{slug}Atualizar integraçõesadmin+
POST/integrations/{slug}/connectCriar integraçõesadmin+
POST/integrations/{slug}/disconnectCriar integraçõesadmin+
POST/integrations/{slug}/syncCriar integraçõesmember+
POST/integrations/{slug}/testCriar integraçõesadmin+
GET/integrations/{slug}/logsListar integraçõesviewer+
GET/webhooksListar integraçõesviewer+
POST/webhooksCriar integraçõesadmin+
PUT/webhooks/{id}Atualizar integraçõesadmin+
DELETE/webhooks/{id}Excluir integraçõesadmin+
POST/webhooks/{id}/testExecutar operação de integraçõesadmin+
GET/webhooks/{id}/logsConsultar integraçõesviewer+

Exemplos

# Estado do serviço (sem autenticação)
curl https://app.eskadia.com/api/v1/health
# Listar contatos
curl -H "Authorization: Bearer esk_live_..." \
  "https://app.eskadia.com/api/v1/contacts?page=1&per_page=20&search=ana"
# Criar contato sem risco de duplicação
curl -X POST \
  -H "Authorization: Bearer esk_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: crm-import-ana-001" \
  -d '{"first_name":"Ana","email":"ana@example.com"}' \
  https://app.eskadia.com/api/v1/contacts

Precisa de uma integração?

Analisamos seu caso, permissões e fluxo de dados antes de conectar sistemas.

Falar com a EskadiaVer guia funcional