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

# Listar leads

`GET /leads`

Lista leads com base nos parâmetros fornecidos.

## Query parameters

- `page` number
- `size` number
- `search` string
- `name` string
- `email` string
- `phone` string
- `orderBy` 'createdAtDesc' | 'nameAsc' — Ordenação da lista de leads
- `createdAtStart` string, date-time
- `agentId` string
- `capture` 'completed' | 'partial'

## Response `200`

Successful response

- object — Página de registros
  - `data` object[], required — Lista de registros da página
    - `id` string, required — Identificador do lead
    - `agentId` string, nullable — Assistente que capturou o lead
    - `name` string, nullable — Nome
    - `email` string, nullable — Email
    - `phone` string, nullable — Telefone
    - `company` string, nullable — Empresa
    - `site` string, nullable — Site
    - `custom` object — Campos
    - `utm` object — Informações de rastreamento UTM
      - `source` string, nullable — Fonte (`utm_source`)
      - `medium` string, nullable — Meio (`utm_medium`)
      - `campaign` string, nullable — Campanha (`utm_campaign`)
      - `content` string, nullable — Conteúdo (`utm_content`)
      - `term` string, nullable — Termo (`utm_term`)
    - `capture` 'completed' | 'partial' — Status da captura de dados do lead
    - `workspaceId` string, required — Identificador do workspace associado
    - `createdAt` string, date-time — Data de criação
    - `updatedAt` string, date-time — Data da última atualização
  - `meta` object, required — Metadados da página
    - `total` number, required — Total de registros
    - `page` number, required — Número da página atual
    - `size` number, required — Quantidade de registros da página
    - `first` number, required — Primeira página
    - `last` number, required — Última página
    - `next` number, nullable, required — Próxima página
    - `previous` number, nullable, required — Página anterior

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/rdstationmentoria/apis/agents.md) · [All operations](https://skmtc.net/rdstationmentoria/apis/agents/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rdstationmentoria/agents/revisions/e86f2f8dff55/schema)