# Listar leads

GET /leads

Os leads da inbox, para o funil e o kanban. Para as conversas com o CRM junto, use `GET /chats`. Para qualquer campo, `filter[<campo>]` (abaixo). O responsável e o atendimento aberto são da conversa: filtre em `GET /chats` (`assigned_to`, `ticket_open`); aqui esses filtros dão 400.

## Autenticação

```json
[
  {
    "token": []
  }
]
```

```json
{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}
```

## Parâmetros

```json
[
  {
    "name": "search",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "description": "Nome, nome completo, e-mail, documento ou telefone contém (sem diferença de maiúsculas)."
  },
  {
    "name": "status",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "description": "Na etapa do funil (exata)."
  },
  {
    "name": "tag",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "description": "Com esta tag do CRM (nome inteiro, sem diferença de maiúsculas)."
  },
  {
    "name": "sort",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "-kanban_order",
        "name",
        "-name"
      ]
    },
    "description": "Ordem: `-kanban_order` (padrão, como no kanban), `name`, `-name`."
  },
  {
    "name": "filter",
    "in": "query",
    "style": "deepObject",
    "explode": true,
    "schema": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "maxItems": 10
          }
        ]
      }
    },
    "example": {
      "status": "novo",
      "fields.field01": "~pro"
    },
    "description": "Filtro por campo, em `filter[<campo>]=<valor>`:\n\n- `filter[name]=Maria`: igual, sem diferenciar maiúsculas (só as letras sem acento). `filter[phone]=` acha os vazios.\n- `~` contém e `!~` não contém (`filter[name]=~mar`); `!=` diferente; `>=`, `>`, `<=`, `<` comparam número, data ou texto.\n- Um `=` na frente força o igual, para o valor que começa com um operador (`filter[name]==~x` acha `~x`).\n- O mesmo campo pode vir duas vezes, para uma faixa: `filter[last_message_at]=>=2026-10-01T00:00:00Z&filter[last_message_at]=<2026-11-01T00:00:00Z`. Na URL, o `+` do fuso vira `%2B` (ou use `Z`). No SDK, a faixa é uma lista: `{ last_message_at: ['>=2026-10-01T00:00:00Z', '<2026-11-01T00:00:00Z'] }` (vai como `filter[last_message_at][0]` e `[1]`, que valem como repetir o campo).\n- Datas em ISO 8601; booleanos `true`/`false` (só `=` e `!=`).\n- Até 10 condições. Os `filter[]` se juntam com E; `match=any` junta com OU. Os outros filtros da rota seguem com E.\n- Campo fora da lista dá 400. Uma consulta com filtro que passa de 5 s dá 504 `unavailable`: estreite o filtro. O servidor roda poucas buscas com filtro ao mesmo tempo; sem vaga em 5 s, dá 503 `unavailable`.\n\nCampos: `name`, `full_name`, `email`, `document`, `status`, `kanban_order`, `fields.field01` a `fields.field20`, e da conversa do lead: `phone`, `unread_count`, `last_message_at` e `notes` (as notas do WhatsApp Business; `~` busca no texto)."
  },
  {
    "name": "match",
    "in": "query",
    "schema": {
      "type": "string",
      "enum": [
        "all",
        "any"
      ],
      "default": "all"
    },
    "description": "Como os `filter[]` se juntam: `all` (E, o padrão) ou `any` (OU)."
  },
  {
    "name": "total",
    "in": "query",
    "schema": {
      "type": "boolean",
      "default": false
    },
    "description": "`true` devolve `total`: quantos itens passam nos filtros, em todas as páginas (o cursor não muda o total), contados até 10 000. Custa uma contagem a mais; mande só quando precisar."
  },
  {
    "name": "limit",
    "in": "query",
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "default": 50
    },
    "description": "Itens por página (1 a 200; padrão 50)."
  },
  {
    "name": "cursor",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "description": "O `next_cursor` da página anterior. Sem ele, vem a primeira página."
  }
]
```

## Respostas

```json
{
  "200": {
    "description": "Os leads.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "leads"
          ],
          "properties": {
            "leads": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/OrkesioLead"
              },
              "description": "Os leads da página."
            },
            "next_cursor": {
              "type": "string",
              "description": "Cursor da próxima página: mande em `cursor`. Ausente na última página."
            },
            "total": {
              "type": "integer",
              "maximum": 10000,
              "description": "Só com `total=true`: quantos itens passam nos filtros, em todas as páginas, até 10 000 (com `total_capped`)."
            },
            "total_capped": {
              "type": "boolean",
              "description": "`true` quando passou de 10 000: `total` para em 10 000. Ausente abaixo disso."
            }
          }
        },
        "example": {
          "leads": [
            {
              "id": "rbb629d0fdfa7b3",
              "phone": "5511999999999",
              "name": "Maria",
              "full_name": "Maria Souza",
              "email": "maria@exemplo.com",
              "document": "12345678900",
              "status": "cliente",
              "tags": [
                "vip"
              ],
              "fields": {
                "field01": "Plano Pro"
              },
              "notes": "Prefere entrega à tarde.",
              "kanban_order": 3
            }
          ],
          "next_cursor": "MXxyYmI2MjlkMGZkZmE3YjM"
        }
      }
    }
  },
  "400": {
    "description": "Filtro inválido.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "invalid_request",
          "message": "limit vai de 1 a 200."
        }
      }
    }
  },
  "401": {
    "description": "Token inválido ou ausente.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "$ref": "#/components/responses/InternalError"
  },
  "503": {
    "description": "`unavailable`: outras buscas com filtro ou `total` estão em andamento; tente de novo.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unavailable",
          "message": "Outras buscas com filtro estão em andamento; tente de novo."
        }
      }
    }
  },
  "504": {
    "description": "`unavailable`: a consulta com `filter[]` ou `total=true` passou de 5 s; estreite o filtro.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unavailable",
          "message": "A consulta passou de 5 s: use filtros mais específicos."
        }
      }
    }
  }
}
```

**Estado:** Disponível

## Compatibilidade de canais

| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim |  |
| WhatsApp (API oficial) | Sim |  |
| Instagram | Sim |  |
| Messenger | Sim |  |
| Telegram | Sim |  |

## Eventos que esta rota gera

Nenhum. Esta rota não gera evento no webhook (nem em `GET /events`): o resultado vem só na resposta.

## Antes e depois (uazapi → Orkesio)

Na uazapi: `POST /chat/find`.

- Lista leads, não conversas; os filtros sem o prefixo `lead_`.

## #/components/schemas/OrkesioLead

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Id do lead na Orkesio. Opaco: guarde como veio, sem montar a partir de outro campo. Hoje é o id interno da conversa onde o lead nasceu."
    },
    "phone": {
      "type": "string",
      "description": "Telefone do contato com DDI (só dígitos), quando conhecido."
    },
    "lid": {
      "type": "string",
      "description": "LID do contato, quando conhecido (só no `whatsapp_web`)."
    },
    "name": {
      "type": "string",
      "description": "Como o contato quer ser chamado (ex.: `Dona Maria`), escrito por você, pela IA ou por um fluxo. Não vem do WhatsApp: os nomes do WhatsApp são `contact_name` e `push_name` da conversa."
    },
    "full_name": {
      "type": "string",
      "description": "Nome completo, para cadastro (nota, contrato), escrito por você, pela IA ou por um fluxo. Não vem do WhatsApp."
    },
    "email": {
      "type": "string",
      "description": "E-mail."
    },
    "document": {
      "type": "string",
      "description": "Documento (CPF/CNPJ ou outro)."
    },
    "status": {
      "type": "string",
      "description": "Etapa do funil, texto livre. A coluna do kanban é outra coisa: a tag com `kanban: true` em `tags`."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Etiqueta do lead."
      },
      "description": "Etiquetas do lead (do CRM, não as do WhatsApp Business)."
    },
    "fields": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Campos personalizados (até 20), pela chave (`field01` a `field20`). O nome de cada um está em `GET /leads/fields`."
    },
    "notes": {
      "type": "string",
      "description": "Notas do CRM, só na Orkesio. Não são as notas do WhatsApp Business (essas são da conversa, em `GET /chats/{chat_id}`)."
    },
    "kanban_order": {
      "type": "integer",
      "description": "Posição do cartão na coluna do kanban (maior aparece primeiro)."
    },
    "identities": {
      "type": "array",
      "description": "As contas do contato em cada canal: uma por conversa ligada ao lead.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "channel",
          "id"
        ],
        "properties": {
          "channel": {
            "type": "string",
            "enum": [
              "whatsapp",
              "telegram",
              "messenger",
              "instagram"
            ],
            "description": "A rede (o WhatsApp Web e a API oficial são a mesma rede: `whatsapp`)."
          },
          "id": {
            "type": "string",
            "description": "O id do contato nesse canal, o mesmo de `chat.id`."
          },
          "username": {
            "type": "string",
            "description": "O nome de usuário nesse canal, quando há."
          }
        }
      }
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "description": "Lead do CRM: o contato, com um lead por contato e por dono (hoje a inbox, então um por conversa direta). Grupo, canal e status não têm lead. Vem sempre em `message.received` e `message.sent` de conversa direta, e em cada conversa direta de `GET /chats`."
}
```

## #/components/schemas/OrkesioError

```json
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}
```

## #/components/responses/RateLimited

```json
{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}
```

## #/components/responses/InternalError

```json
{
  "description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "internal_error",
        "message": "Falha inesperada."
      }
    }
  }
}
```

## Guias relacionados

[Visão geral](/docs/overview) · [O que funciona em cada canal](/docs/canais) · [O que muda da uazapi](/docs/o-que-muda)