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 headerAuthorization:
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:?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
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.

