curl --request GET \
--url 'https://crm.wavups.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",
"taxId": "12345678909",
"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",
"accountCRMLeadLabelAssignments": [
{
"AccountLabel": {
"id": "lbl_001",
"name": "Quente",
"color": "#ef4444"
}
}
],
"accountExternalConversations": [
{
"id": "clconv001",
"contactName": "João Silva",
"contactPhone": "5511999998888",
"contactUsername": null,
"status": "active",
"unreadCount": 0,
"lastMessageAt": "2025-06-15T15:00:00.000Z",
"accountChatSectorId": "csector001",
"conversationOwnerId": "usr_abc",
"createdAt": "2025-06-15T14:30:00.000Z",
"AccountChatSector": {
"id": "csector001",
"name": "Comercial",
"color": "#3B82F6"
},
"PlatformIntegration": {
"name": "WhatsApp Business"
}
}
]
}
{
"error": "Lead not found"
}
{
"error": "Error to get lead"
}
Leads
Obter Lead
Retorna os detalhes de um lead específico pelo ID.
GET
/
lead
/
{id}
curl --request GET \
--url 'https://crm.wavups.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",
"taxId": "12345678909",
"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",
"accountCRMLeadLabelAssignments": [
{
"AccountLabel": {
"id": "lbl_001",
"name": "Quente",
"color": "#ef4444"
}
}
],
"accountExternalConversations": [
{
"id": "clconv001",
"contactName": "João Silva",
"contactPhone": "5511999998888",
"contactUsername": null,
"status": "active",
"unreadCount": 0,
"lastMessageAt": "2025-06-15T15:00:00.000Z",
"accountChatSectorId": "csector001",
"conversationOwnerId": "usr_abc",
"createdAt": "2025-06-15T14:30:00.000Z",
"AccountChatSector": {
"id": "csector001",
"name": "Comercial",
"color": "#3B82F6"
},
"PlatformIntegration": {
"name": "WhatsApp Business"
}
}
]
}
{
"error": "Lead not found"
}
{
"error": "Error to get lead"
}
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).
array
array
Lista de conversas vinculadas ao lead (sem o conteúdo da última mensagem).
Show Propriedades da Conversa
Show Propriedades da Conversa
string
Identificador único da conversa.
string
Nome do contato.
string | null
Telefone do contato.
string | null
Username do contato.
string
Status da conversa (
active, closed, etc.).number
Quantidade de mensagens não lidas.
string | null
Data e hora da última mensagem (ISO 8601).
string | null
ID do setor do chat associado.
string | null
ID do responsável pela conversa.
string
Data de criação da conversa (ISO 8601).
object | null
Dados do setor da conversa (id, name, color).
object | null
Dados da plataforma integrada (
name).Exemplos
curl --request GET \
--url 'https://crm.wavups.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",
"taxId": "12345678909",
"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",
"accountCRMLeadLabelAssignments": [
{
"AccountLabel": {
"id": "lbl_001",
"name": "Quente",
"color": "#ef4444"
}
}
],
"accountExternalConversations": [
{
"id": "clconv001",
"contactName": "João Silva",
"contactPhone": "5511999998888",
"contactUsername": null,
"status": "active",
"unreadCount": 0,
"lastMessageAt": "2025-06-15T15:00:00.000Z",
"accountChatSectorId": "csector001",
"conversationOwnerId": "usr_abc",
"createdAt": "2025-06-15T14:30:00.000Z",
"AccountChatSector": {
"id": "csector001",
"name": "Comercial",
"color": "#3B82F6"
},
"PlatformIntegration": {
"name": "WhatsApp Business"
}
}
]
}
{
"error": "Lead not found"
}
{
"error": "Error to get lead"
}
Authorizations
Token de autenticacao gerado na plataforma WavUps CRM.
Path Parameters
Identificador único do recurso.
Response
Lead encontrado.
Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos ou simbolos).
Example:
"5547999999999"
CPF ou CNPJ do lead.
Example:
"12345678909"
Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).
Metadados adicionais do lead em formato JSON.
Parâmetros UTM associados ao lead em formato JSON.
Show child attributes
Show child attributes
Lista de conversas vinculadas ao lead.
Show child attributes
Show child attributes

