Skip to main content
GET
Listar Leads

Authorizations

Token
string
header
required

Token de autenticacao gerado na plataforma WavUps CRM.

Query Parameters

startDate
string<date-time>

Data de início para filtrar leads pelo campo createdAt (ISO 8601, ex: 2025-01-01T00:00:00Z).

endDate
string<date-time>

Data de fim para filtrar leads pelo campo createdAt (ISO 8601, ex: 2025-12-31T23:59:59Z).

temperature
enum<integer>

Filtra leads pela temperatura: 1 (Frio), 2 (Morno) ou 3 (Quente).

Available options:
1,
2,
3
source
string

Filtra leads pela origem (ex: site, instagram, indicacao).

phone
string

Filtra leads por número de telefone exato.

taxId
string

Filtra leads por número de CPF ou CNPJ exato.

leadOwner
string

Filtra leads pelo ID do usuário responsável.

leadType
string

Filtra leads pelo tipo (ex: PF, PJ).

labelId
string

Filtra leads que possuem a etiqueta com o ID informado.

Response

Lista de leads retornada com sucesso.

id
string
leadOwner
string | null
name
string
email
string | null
phone
string | null

Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos ou simbolos).

Example:

"5547999999999"

taxId
string | null

CPF ou CNPJ do lead.

Example:

"12345678909"

source
string | null
profileImage
string | null
zipCode
string | null
state
string | null
city
string | null
neighborhood
string | null
streetAddress
string | null
number
string | null
complement
string | null
description
string | null
leadType
string | null
leadTemperature
number | null

Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).

status
string
metadata
object | null

Metadados adicionais do lead em formato JSON.

utms
object | null

Parâmetros UTM associados ao lead em formato JSON.

createdAt
string<date-time>