---
title: "Listar Leads retornados pela busca"
method: GET
path: "/{alias}/search/leads"
tags: ["Busca - Leads"]
---

# Listar Leads retornados pela busca

`GET /{alias}/search/leads`

## Request

- Base URL: `https://api.dooki.com.br/v2`
- URL: `https://api.dooki.com.br/v2/{alias}/search/leads`
- Auth: API key in header `User-Token` and API key in header `User-Secret-Key`

lista leads retornados pela busca

## Path parameters

- `alias` string, required

## Response `200`

Lista de leads através da busca

- Lead: Representa um lead da lista de leads
  - `id` integer: ID do lead.
  - `merchant_id` integer: ID da loja dona do lead.
  - `name` string: Nome do lead.
  - `email` string: E-mail informado pelo lead.
  - `birthday` string, date: Data de nascimento do lead.
  - `city` string: Cidade informada pelo lead.
  - `state` string: Unidade federativa (estado) informada pelo lead.
  - `genre` string: Gênero informado pelo lead: `m` para masculino e `f` para feminino.
  - `utm_source` string: Origem da campanha de marketing (parâmetro UTM `utm_source`) que originou o lead.
  - `utm_campaign` string: Nome da campanha de marketing (parâmetro UTM `utm_campaign`) que originou o lead.
  - `utm_medium` string: Meio/canal de marketing (parâmetro UTM `utm_medium`) que originou o lead.
  - `utm_term` string: Termo de busca (parâmetro UTM `utm_term`) que originou o lead.
  - `utm_content` string: Conteúdo do anúncio/link (parâmetro UTM `utm_content`) que originou o lead.
  - `params` string: Parâmetros adicionais enviados no cadastro do lead, no formato chave-valor.
  - `is_customer` boolean: Indica se o lead já se tornou cliente da loja.
  - `customer_id` integer: ID do cliente correspondente ao lead, quando ele já tiver se tornado cliente da loja.
  - `customer_since` string, date: Data em que o lead se tornou cliente da loja.
  - `created_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
    - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
    - `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.

## Other responses

- `400`: Requisição inválida
- `404`: URL inválida

## Changes

- **2026-11-03** `bbafb577e11c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/yampi/apis/yampi-api/changes/:alias/search/leads/get.md)

---

[API](https://skmtc.dev/yampi/apis/yampi-api.md) - [All operations](https://skmtc.dev/yampi/apis/yampi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yampi/apis/yampi-api/revisions/74739ec8876f?raw)