Skip to main content
GET
/
lead
Listar Leads
curl --request GET \
  --url https://sell.ia.proativia.com/api/v1/lead \
  --header 'Token: <api-key>'
[
  {
    "id": "<string>",
    "leadOwner": "<string>",
    "name": "<string>",
    "email": "<string>",
    "phone": "5547999999999",
    "source": "<string>",
    "profileImage": "<string>",
    "zipCode": "<string>",
    "state": "<string>",
    "city": "<string>",
    "neighborhood": "<string>",
    "streetAddress": "<string>",
    "number": "<string>",
    "complement": "<string>",
    "description": "<string>",
    "leadType": "<string>",
    "leadTemperature": 123,
    "status": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Token
string
header
required

Token de autenticacao gerado na plataforma Sell.IA.

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.

​
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"

​
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
​
createdAt
string<date-time>