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

# Listar leads

`GET /{alias}/leads`

Lista os leads de acordo com os filtros estabelecidos

## Path parameters

- `alias` string, required

## Query parameters

- `name` string
- `email` string, email
- `birthday` string, date
- `city` string
- `state` string
- `genre` string
- `params` object

## Response `200`

Lista de leads

- object — Representa uma paginação com meta
  - `data` Lead[]
    - `id` integer
    - `merchant_id` integer
    - `name` string
    - `email` string
    - `birthday` string, date
    - `city` string
    - `state` string
    - `genre` string
    - `utm_source` string
    - `utm_campaign` string
    - `utm_medium` string
    - `utm_term` string
    - `utm_content` string
    - `params` string
    - `is_customer` boolean
    - `customer_id` integer
    - `customer_since` string, date
    - `created_at` BaseTimestamp
      - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
      - `timezone_type` integer — Número de representação do timezone.
      - `timezone` string — Fuso horário associado.
    - `updated_at` BaseTimestamp
      - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
      - `timezone_type` integer — Número de representação do timezone.
      - `timezone` string — Fuso horário associado.
  - `meta` object
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
      - `links` object
        - `previous` string
        - `next` string

## Other responses

- `400` — Dados inválidos fornecidos

---

[API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/versions/fa16c50bef09/schema)