Pular para o conteúdo principal

​
Visão Geral

A API do Leavo segue os princípios REST e utiliza JSON para todas as requisições e respostas.

​
Base URL

https://api.leavo.ai
Todos os endpoints começam com o prefixo /backend (exceto /ai/process).

​
Autenticação

Todas as requisições devem incluir o header Authorization: 
Authorization: Bearer sua_chave_aqui

Saiba mais sobre Autenticação

Configure sua chave de API

​
Endpoints Disponíveis

Leads

Gerenciamento completo de leads

Status

Gerenciar status de leads

Tags

Organizar leads com tags

Webhooks

Integração bidirecional

Custom Fields

Campos personalizados

Cadences

Sequências automatizadas

Conversations

Gerenciar conversas

Messages

Enviar e receber mensagens

​
Convenções

​
Métodos HTTP

MétodoUso
GETBuscar recursos
POSTCriar recursos
PUTAtualizar recursos
DELETERemover recursos

​
Paginação

Endpoints que retornam listas suportam paginação:
ParâmetroTipoDescrição
limitintegerNúmero máximo de itens (default: 50)
offsetintegerItens a pular (default: 0)
GET /backend/leads?limit=20&offset=40

​
Filtros

Muitos endpoints suportam filtros via query string: 
GET /backend/leads?status=active&search=joao

​
Formato de Data

Todas as datas seguem o formato ISO 8601: 
2024-01-15T10:30:00Z

​
Rate Limiting

A API possui limites de requisições para garantir a estabilidade:
  • 100 requisições por minuto por chave de API
  • Header Retry-After indica quando tentar novamente
HTTP/1.1 429 Too Many Requests
Retry-After: 60

​
Versionamento

A API está atualmente na versão 1 (implícita na URL base). Mudanças breaking serão comunicadas com antecedência.