> ## Documentation Index
> Fetch the complete documentation index at: https://docs.leavo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Documentação completa de todos os endpoints da API

## 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`:

```bash theme={null}
Authorization: Bearer sua_chave_aqui
```

<Card title="Saiba mais sobre Autenticação" icon="key" href="/pt-BR/authentication">
  Configure sua chave de API
</Card>

## Endpoints Disponíveis

<CardGroup cols={2}>
  <Card title="Leads" icon="users" href="/pt-BR/api-reference/leads/list">
    Gerenciamento completo de leads
  </Card>

  <Card title="Status" icon="flag" href="/pt-BR/api-reference/status/list">
    Gerenciar status de leads
  </Card>

  <Card title="Tags" icon="tags" href="/pt-BR/api-reference/tags/list">
    Organizar leads com tags
  </Card>

  <Card title="Webhooks" icon="webhook" href="/pt-BR/api-reference/webhooks/overview">
    Integração bidirecional
  </Card>

  <Card title="Custom Fields" icon="sliders" href="/pt-BR/api-reference/custom-fields/overview">
    Campos personalizados
  </Card>

  <Card title="Cadences" icon="calendar" href="/pt-BR/api-reference/cadences/overview">
    Sequências automatizadas
  </Card>

  <Card title="Conversations" icon="comments" href="/pt-BR/api-reference/conversations/list">
    Gerenciar conversas
  </Card>

  <Card title="Messages" icon="message" href="/pt-BR/api-reference/messages/get">
    Enviar e receber mensagens
  </Card>

  <Card title="Departamentos" icon="building" href="/pt-BR/api-reference/departments/overview">
    Organize equipes e controle visibilidade
  </Card>

  <Card title="Upload de Arquivos" icon="cloud-arrow-up" href="/pt-BR/api-reference/uploads/overview">
    Envie imagens, áudios e documentos
  </Card>

  <Card title="Templates" icon="file-lines" href="/pt-BR/api-reference/templates/overview">
    Templates do WhatsApp Business (Meta/Gupshup)
  </Card>

  <Card title="Follow-up" icon="clock-rotate-left" href="/pt-BR/api-reference/followup/overview">
    Reengajamento automático com IA e templates
  </Card>
</CardGroup>

## Convenções

### Métodos HTTP

| Método   | Uso                |
| -------- | ------------------ |
| `GET`    | Buscar recursos    |
| `POST`   | Criar recursos     |
| `PUT`    | Atualizar recursos |
| `DELETE` | Remover recursos   |

### Paginação

Endpoints que retornam listas suportam paginação:

| Parâmetro | Tipo    | Descrição                            |
| --------- | ------- | ------------------------------------ |
| `limit`   | integer | Número máximo de itens (default: 50) |
| `offset`  | integer | Itens a pular (default: 0)           |

```bash theme={null}
GET /backend/leads?limit=20&offset=40
```

### Filtros

Muitos endpoints suportam filtros via query string:

```bash theme={null}
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 theme={null}
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.