Skip to main content
GET

Requisição

string
required
Seu token de autenticação.

Path Parameters

string
required
ID do lead a ser recuperado.

Resposta

Retorna o objeto completo do lead solicitado.
string
Identificador único do lead.
string
ID da conta à qual o lead pertence.
string | null
ID do usuário responsável pelo lead.
string
Nome do lead.
string | null
E-mail do lead.
string | null
Telefone do lead.
string | null
CPF/CNPJ do lead.
string | null
Origem do lead.
string | null
URL da imagem de perfil do lead.
string | null
CEP do endereço do lead.
string | null
Estado do lead.
string | null
Cidade do lead.
string | null
Bairro do lead.
string | null
Logradouro do lead.
string | null
Número do endereço.
string | null
Complemento do endereço.
string | null
Descrição ou observações sobre o lead.
string | null
Tipo do lead (ex: PF, PJ).
number | null
Temperatura do lead: 1 (Frio), 2 (Morno) ou 3 (Quente).
object | null
Metadados adicionais do lead em formato JSON.
object | null
Parâmetros UTM associados ao lead em formato JSON.
string
Status atual do lead.
string
Data e horário de criação do lead (ISO 8601).
string
Data e horário da última atualização (ISO 8601).

Exemplos

Authorizations

Token
string
header
required

Token de autenticacao gerado na plataforma WavUps CRM.

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"

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>