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",
  "country": "Brasil",
  "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"
      }
    }
  ]
}

Requisição

Tokenstringobrigatório

Seu token de autenticação.

Path Parameters

idstringobrigatório

ID do lead a ser recuperado.

Query Parameters

includestring

Dados extras na resposta. Use groups para trazer os grupos do lead (groups e company). Sem este parâmetro a resposta não muda.

Resposta

Retorna o objeto completo do lead solicitado.

idstring

Identificador único do lead.

accountIdstring

ID da conta à qual o lead pertence.

leadOwnerstring | null

ID do usuário responsável pelo lead.

namestring

Nome do lead.

emailstring | null

E-mail do lead.

phonestring | null

Telefone do lead.

taxIdstring | null

CPF/CNPJ do lead.

sourcestring | null

Origem do lead.

profileImagestring | null

URL da imagem de perfil do lead.

zipCodestring | null

CEP do endereço do lead.

statestring | null

Estado do lead.

citystring | null

Cidade do lead.

neighborhoodstring | null

Bairro do lead.

streetAddressstring | null

Logradouro do lead.

numberstring | null

Número do endereço.

complementstring | null

Complemento do endereço.

countrystring | null

País do lead, em português (ex: Brasil).

descriptionstring | null

Descrição ou observações sobre o lead.

leadTypestring | null

Tipo do lead (ex: PF, PJ).

leadTemperaturenumber | null

Temperatura do lead: 1 (Frio), 2 (Morno) ou 3 (Quente).

metadataobject | null

Metadados adicionais do lead em formato JSON.

customFieldsobject

Campos personalizados preenchidos do lead, pela chave do campo. Campos de seleção trazem o nome da opção e os de seleção múltipla uma lista de nomes. Campos sem valor não aparecem; sem nenhum, vem {}.

groupsarray

Só com ?include=groups. Grupos de que o lead é uma das pessoas: cada item traz id, name (o nome do grupo) e role (o cargo do lead nele).

companyobject | null

Só com ?include=groups. Grupo de que o lead é a empresa, com id, name e peopleCount (quantidade de pessoas). null quando o lead não é a empresa de nenhum grupo.

utmsobject | null

Parâmetros UTM associados ao lead em formato JSON.

statusstring

Status atual do lead.

createdAtstring

Data e horário de criação do lead (ISO 8601).

accountCRMLeadLabelAssignmentsarray

Lista de etiquetas atribuídas ao lead.

accountExternalConversationsarray

Lista de conversas vinculadas ao lead (sem o conteúdo da última mensagem).

Autorização

Tokenstring · headerobrigatório

Token de autenticacao gerado na plataforma WavUps CRM.

Parâmetros de caminho

idstringobrigatório

Identificador único do recurso.

Parâmetros de consulta

includeenum<string>

Dados extras na resposta. Use `groups` para trazer os grupos do lead (`groups` e `company`). Sem este parâmetro a resposta não muda.

Valores aceitos: groups

Respostas

200application/json · object

Lead encontrado.

idstring

leadOwnerstring | null

namestring

emailstring | null

phonestring | null

Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos ou simbolos).

Exemplo: "5547999999999"

taxIdstring | null

CPF ou CNPJ do lead.

Exemplo: "12345678909"

sourcestring | null

profileImagestring | null

zipCodestring | null

statestring | null

citystring | null

neighborhoodstring | null

streetAddressstring | null

numberstring | null

complementstring | null

countrystring | null

Pais do lead, em portugues. Um nome da lista de paises da plataforma e gravado com a grafia dela (sem diferenciar maiusculas e acentos); outro texto e gravado como veio.

Exemplo: "Brasil"

descriptionstring | null

leadTypestring | null

leadTemperaturenumber | null

Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).

statusstring

metadataobject | null

Metadados adicionais do lead em formato JSON.

customFieldsobject

Campos personalizados do lead preenchidos, pela chave do campo. Campos de seleção trazem o nome da opção e os de seleção múltipla uma lista de nomes. Campos sem valor não aparecem.

Exemplo:

{
  "plano": "Ouro",
  "limite_de_credito": 1500,
  "cliente_vip": true
}

groupsobject[]

Só com `?include=groups`. Grupos de que o lead é uma das pessoas, com o cargo dele em cada um.

Exemplo:

[
  {
    "id": "cmg1grupo01",
    "name": "Acqua Distribuidora",
    "role": "Comprador"
  }
]

companyobject | null

Só com `?include=groups`. Grupo de que o lead é a empresa; `null` quando o lead não é empresa de nenhum grupo.

Exemplo:

{
  "id": "cmg1grupo01",
  "name": "Acqua Distribuidora",
  "peopleCount": 3
}

utmsobject | null

Parâmetros UTM associados ao lead em formato JSON.

createdAtstring<date-time>

accountExternalConversationsobject[]

Lista de conversas vinculadas ao lead.

404

500