Skip to main content

Visão Geral da API

A API REST do SalesOS permite integrar a plataforma com seus sistemas internos, automações e ferramentas de terceiros.

Informações básicas

Autenticação

Todas as requisições à API exigem um token JWT válido no header Authorization:
Consulte o guia de Autenticação para detalhes sobre como obter e renovar tokens.

Endpoints disponíveis

Leads

CRUD completo de leads: criar, listar, atualizar e excluir.

Vendas

Gerenciar oportunidades, etapas do pipeline e deals.

Usuários

Listar e gerenciar usuários e equipes.

Webhooks

Configurar webhooks para receber eventos em tempo real.

Padrões da API

Paginação

Endpoints que retornam listas suportam paginação:
Parâmetros: ?page=1&per_page=20

Respostas de erro

Erros seguem um formato padronizado:

Códigos HTTP

Filtros

Use query parameters para filtrar resultados:
  • Prefixo - indica ordenação decrescente
  • Datas no formato ISO 8601
Use o header X-Request-ID para rastrear requisições. Se precisar de suporte, informe o request ID para facilitar a investigação.
A API está disponível apenas nos planos Professional e Enterprise. Verifique seu plano em Configurações > Plano.

Integrações

SalesOS Connect (n8n)

Automações visuais com n8n.

Pagamentos

API de cobranças, payouts e extrato.

Integrações Custom

Crie suas próprias integrações.