Skip to main content
GET
/
lead
curl --request GET \
  --url 'https://sell.ia.proativia.com/api/v1/lead?startDate=2025-01-01T00:00:00Z&endDate=2025-12-31T23:59:59Z&source=instagram' \
  --header 'Token: SEU_TOKEN_DE_API'

[
  {
    "id": "clxyz1234",
    "leadOwner": "usr_abc",
    "name": "João Silva",
    "email": "joao@email.com",
    "phone": "5511999998888",
    "source": "instagram",
    "profileImage": null,
    "zipCode": "01310-100",
    "state": "SP",
    "city": "São Paulo",
    "neighborhood": "Bela Vista",
    "streetAddress": "Av. Paulista",
    "number": "1000",
    "complement": "Apto 21",
    "description": "Interesse em plano premium",
    "leadType": "PF",
    "leadTemperature": 2,
    "status": "Lead",
    "createdAt": "2025-06-15T14:30:00.000Z",
    "accountCRMLeadLabelAssignments": [
      {
        "AccountLabel": {
          "id": "lbl_001",
          "name": "Quente",
          "color": "#ef4444"
        }
      }
    ]
  }
]

​
Requisição

GET https://sell.ia.proativia.com/api/v1/lead
​
Token
string
required
Seu token de autenticação.

​
Query Parameters

​
startDate
string
Data de início para filtrar leads pelo campo createdAt. Deve ser uma data válida no formato ISO 8601 (ex: 2025-01-01T00:00:00Z). Utilizado em conjunto com endDate.
​
endDate
string
Data de fim para filtrar leads pelo campo createdAt. Deve ser uma data válida no formato ISO 8601 (ex: 2025-12-31T23:59:59Z). Utilizado em conjunto com startDate.
​
temperature
number
Filtra leads pela temperatura: 1 (Frio), 2 (Morno) ou 3 (Quente).
​
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 pelo lead.
​
leadType
string
Filtra leads pelo tipo (ex: PF, PJ).
​
labelId
string
Filtra leads que possuem a etiqueta com o ID informado.

​
Resposta

Retorna um array de objetos de lead. Os campos accountId e updatedAt são omitidos na resposta.
​
id
string
Identificador único do lead.
​
leadOwner
string | null
ID do usuário responsável pelo lead.
​
name
string
Nome do lead.
​
email
string | null
E-mail do lead.
​
phone
string | null
Telefone do lead.
​
source
string | null
Origem do lead.
​
profileImage
string | null
URL da imagem de perfil do lead.
​
zipCode
string | null
CEP do endereço do lead.
​
state
string | null
Estado do lead.
​
city
string | null
Cidade do lead.
​
neighborhood
string | null
Bairro do lead.
​
streetAddress
string | null
Logradouro do lead.
​
number
string | null
Número do endereço.
​
complement
string | null
Complemento do endereço.
​
description
string | null
Descrição ou observações sobre o lead.
​
leadType
string | null
Tipo do lead (ex: PF, PJ).
​
leadTemperature
number | null
Temperatura do lead: 1 (Frio), 2 (Morno) ou 3 (Quente).
​
status
string
Status atual do lead. Padrão: Lead.
​
createdAt
string
Data e horário de criação do lead (ISO 8601).
​
accountCRMLeadLabelAssignments
array
Lista de etiquetas atribuídas ao lead.

​
Exemplos

curl --request GET \
  --url 'https://sell.ia.proativia.com/api/v1/lead?startDate=2025-01-01T00:00:00Z&endDate=2025-12-31T23:59:59Z&source=instagram' \
  --header 'Token: SEU_TOKEN_DE_API'

[
  {
    "id": "clxyz1234",
    "leadOwner": "usr_abc",
    "name": "João Silva",
    "email": "joao@email.com",
    "phone": "5511999998888",
    "source": "instagram",
    "profileImage": null,
    "zipCode": "01310-100",
    "state": "SP",
    "city": "São Paulo",
    "neighborhood": "Bela Vista",
    "streetAddress": "Av. Paulista",
    "number": "1000",
    "complement": "Apto 21",
    "description": "Interesse em plano premium",
    "leadType": "PF",
    "leadTemperature": 2,
    "status": "Lead",
    "createdAt": "2025-06-15T14:30:00.000Z",
    "accountCRMLeadLabelAssignments": [
      {
        "AccountLabel": {
          "id": "lbl_001",
          "name": "Quente",
          "color": "#ef4444"
        }
      }
    ]
  }
]

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>