---
title: "Listar leads"
method: GET
path: "/leads"
tags: ["crm-v2-leads"]
---

# Listar leads

`GET /leads`

## Request

- Base URL: `https://api.rd.services/crm/v2`
- URL: `https://api.rd.services/crm/v2/leads`
- Auth: OAuth 2
  - Authorization code: `/oauth/authorize`
  - Token URL: `/oauth/token`

Recupera uma lista paginada de leads da conta. A paginação padrão é de 25 registros por página, com no máximo 200.

## Filtro

Propriedades disponíveis para filtro usando [RDQL](crm-v2-rdql-filtering).

| Propriedade | Tipo | Descrição |
| :--- | :--- | :--- |
| `id` | `String` | Filtra por um ou mais IDs. Operador `in`. Exemplo: `id:(507f1f77bcf86cd799439011,507f191e810c19729de860ea)`. |
| `name` | `String` | Filtra pelo nome. Suporta busca exata e correspondência de termo (operador `~`). Exemplo: `name:~Acme`. |
| `rating` | `Integer` | Filtra pela qualificação (1 a 5). Exemplo: `rating:(2,3)`. |
| `status` | `String` | Filtra pelo status. Apenas o operador `in`. Valores: `ongoing`, `converted`, `discarded`. Exemplo: `status:(ongoing,discarded)`. |
| `stage_id` | `String` | Filtra pelo ID da etapa do lead. |
| `source_id` | `String` | Filtra pelo ID da fonte. |
| `campaign_id` | `String` | Filtra pelo ID da campanha. |
| `organization_id` | `String` | Filtra pelo ID da empresa. |
| `contact_id` | `String` | Filtra pelo ID de um contato vinculado. |
| `owner_id` | `String` | Filtra pelo ID do responsável. |
| `created_at` | `DateTime` | Filtra pela data de criação. Aceita intervalo (`>=`, `<=`, `>`, `<`). |
| `updated_at` | `DateTime` | Filtra pela data da última atualização. Aceita intervalo (`>=`, `<=`, `>`, `<`). |

## Ordenação

Propriedades disponíveis para [ordenação](crm-v2-introduction#ordenação).

* `name`
* `created_at`
* `rating`

## Query parameters

- `filter` string
- `sort` object
- `page` object
  - `number` integer: Número da página.
  - `size` integer: Tamanho da página.

## Response `200`

OK

- object
  - `data` object[]: Lista de recursos relacionados.
    - `id` string: Identificador único.
    - `name` string: Nome do lead. Obrigatório na criação. Mínimo de 2 e máximo de 255 caracteres.
    - `status` 'ongoing' | 'converted' | 'discarded': Status do lead. Na criação, somente `ongoing` (padrão). Valores: `ongoing`, `converted`, `discarded`.
    - `rating` integer: Qualificação do lead, de 1 a 5. Padrão `1`.
    - `stage_id` string: ID da etapa do lead. Na criação, se omitido, o lead é associado à primeira etapa do funil.
    - `source_id` string: ID da fonte do lead.
    - `campaign_id` string: ID da campanha associada ao lead.
    - `organization_id` string: ID da empresa associada ao lead.
    - `contact_ids` string[]: IDs dos contatos vinculados ao lead. Todos devem existir na conta.
    - `owner_id` string: ID do usuário responsável pelo lead. Obrigatório na criação.
    - `created_at` string, date-time: Data de criação do lead.
    - `updated_at` string, date-time: Data de atualização do lead.
  - `links` object: Links de navegação da paginação.
    - `first` string, uri: Link para a primeira página.
    - `prev` string, uri: Link para a página anterior.
    - `self` string, uri: Link para a página atual.
    - `next` string, uri: Link para a próxima página.
    - `last` string, uri: Link para a última página.

## Other responses

- `400`: A requisição está malformada e não consegue ser processada.
- `401`: O token da API está ausente ou inválido.
- `403`: O token não tem permissão para acessar o recurso solicitado.
- `429`: O limite de requisições foi excedido.
- `500`: Erro interno ou inesperado no servidor.

---

[API](https://skmtc.dev/rdstation/apis/rd-station-crm-api-v2.md) - [All operations](https://skmtc.dev/rdstation/apis/rd-station-crm-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/rdstation/apis/rd-station-crm-api-v2/revisions/10d0a25b8c54?raw)