Skip to main content
GET
/
lead
/
{id}
curl --request GET \
  --url 'https://sell.ia.proativia.com/api/v1/lead/clxyz1234' \
  --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,
  "metadata": {
    "tags": ["premium", "interessado"],
    "custom_field": "valor customizado"
  },
  "utms": {
    "utm_source": "instagram",
    "utm_medium": "social",
    "utm_campaign": "campanha_junho"
  },
  "status": "Lead",
  "createdAt": "2025-06-15T14:30:00.000Z",
  "updatedAt": "2025-06-15T14:30:00.000Z"
}

​
Requisição

​
Token
string
required
Seu token de autenticação.

​
Path Parameters

​
id
string
required
ID do lead a ser recuperado.

​
Resposta

Retorna o objeto completo do lead solicitado.
​
id
string
Identificador único do lead.
​
accountId
string
ID da conta à qual o lead pertence.
​
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).
​
metadata
object | null
Metadados adicionais do lead em formato JSON.
​
utms
object | null
Parâmetros UTM associados ao lead em formato JSON.
​
status
string
Status atual do lead.
​
createdAt
string
Data e horário de criação do lead (ISO 8601).
​
updatedAt
string
Data e horário da última atualização (ISO 8601).

​
Exemplos

curl --request GET \
  --url 'https://sell.ia.proativia.com/api/v1/lead/clxyz1234' \
  --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,
  "metadata": {
    "tags": ["premium", "interessado"],
    "custom_field": "valor customizado"
  },
  "utms": {
    "utm_source": "instagram",
    "utm_medium": "social",
    "utm_campaign": "campanha_junho"
  },
  "status": "Lead",
  "createdAt": "2025-06-15T14:30:00.000Z",
  "updatedAt": "2025-06-15T14:30:00.000Z"
}

Authorizations

​
Token
string
header
required

Token de autenticacao gerado na plataforma Sell.IA.

Path Parameters

​
id
string
required

Identificador único do recurso.

Response

Lead encontrado.

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