Obter lead por ID

Retorna o registro completo do lead (identidade, apelido, e-mail, nascimento, responsável, consentimento, contagens e version) com o histórico de campanhas e o status da janela do WhatsApp. A lista de campanhas traz só as conversas que você pode abrir: conversas de outros departamentos, ou de outras pessoas quando você não pode ver as conversas dos colegas, não aparecem. Traz também os telefones de contato (phones), os endereços (addresses, com geoStatus e, quando já localizado, a posição e a precisão). A família vem só contada (relativesCount, parentes, e referredCount, pessoas que este lead indicou); a lista sai página por página em GET /v1/leads/{id}/relatives, quando a aba Família é aberta. Os campos personalizados vêm em customFields: os marcados como sensíveis só aparecem para quem tem leads:read_sensitive, e valores de campos que não existem mais nunca saem do servidor. Sem leads:read_addresses, cada endereço traz só bairro, cidade, UF e o código IBGE da cidade (sem CEP, rua, número, complemento nem posição). O consentimento (whatsappOptIn) traz a data, a origem e a finalidade (purpose) registrada. ownerName é o nome do responsável (ausente quando o lead não tem responsável; se o nome não puder ser lido, a resposta é 500, nunca uma ficha sem o nome). As contagens das abas Negociações e Memórias e os outros leads que têm os mesmos números saem em GET /leads/{id}/summary (rota do painel, fora da /v1), para que uma falha nelas não derrube a ficha. Envie a version recebida no cabeçalho If-Match ao editar.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID do lead (UUID)

Headers
string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json