> For the complete documentation index, see [llms.txt](https://outboundpro.gitbook.io/api-v1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://outboundpro.gitbook.io/api-v1/lead/detalhar-lead.md). # Detalhar lead ## Detalhar 1 lead > Retorna \*\*todos os campos\*\* de um lead específico — endereço completo,\ > sócios (contatos), CNAEs secundários, tags, scoring, status, lista,\ > próximas ações. É a fonte de verdade pra puxar o estado atual de um\ > registro depois de qualquer operação de modificação.\ > \ > Use após obter \`id\` de \[\`lead/list\`]\(#operation/leadList) ou\ > \[\`lead/search\`]\(#operation/leadSearch).\ > \ > \### Quando usar\ > \- \*\*Tela de detalhes\*\* no CRM externo — usuário clica num registro e\ > o sistema chama esse endpoint pra mostrar tudo numa página.\ > \- \*\*Pós-modificação\*\* — após \`/contact/create\`, \`/edit\` ou qualquer mudança,\ > chama aqui pra refrescar o estado completo.\ > \- \*\*Validação pré-action\*\* — antes de mandar e-mail/WhatsApp, confere\ > que o lead ainda tem os contatos válidos.\ > \ > \### Quando NÃO usar\ > \- \*\*Listar vários\*\* — use \`/lead/list\` ou \`/lead/search\`. Detail é por ID único.\ > \- \*\*Cache local\*\* — os dados mudam (sócios podem ser atualizados pelo painel\ > ou outras integrações). Sempre busca antes de operar.\ > \ > \### Casos de uso reais\ > \- \*\*Salesforce Lightning component\*\*: ao abrir registro, faz call → mostra\ > cards de sócios + telefones + emails + scoring lado a lado.\ > \- \*\*Workflow de qualificação\*\*: ao mover lead de status no CRM externo, chama\ > aqui pra ver scoring + tags + última prospecção, decide se vai pra "qualificado".\ > \- \*\*WhatsApp bot\*\*: bot recebe número de CNPJ no chat, busca o lead, mostra\ > resumo dos sócios e telefones pra equipe comercial.
```json {"openapi":"3.0.3","info":{"title":"OutboundPro API","version":"2.0.0"},"tags":[{"name":"Lead","description":"**Empresas já existentes na sua base** (após enriquecimento via\n[Company](#tag/Company) ou cadastro manual no painel).\n\nO termo \"Lead\" no OutboundPro = \"empresa rastreada por você\". Cada lead tem\nstatus (Novo, Em prospecção, Convertido, etc.), lista vinculada, scoring\nautomático e contatos (sócios) associados.\n\n### Diferença Company × Lead\n- **Company** = empresa pelo CNPJ; consulta a base pública (RFB) do OutboundPro e pode salvar como lead.\n- **Lead** = consulta sua base local; **rápido**, sem lookup externo.\n\nSe você sabe que a empresa já está na sua base, prefira `lead/*` por\nperformance.\n\n### Estrutura típica\n- `id` (`emp_codigo`) ou `hash` (`emp_hash`) — identificadores estáveis.\n- `status` — fluxo configurável por cliente ([Status](#tag/Status)).\n- `lista` — agrupamento ([List](#tag/List)).\n- `contatos` — sócios ([Contact](#tag/Contact)).\n"}],"servers":[{"url":"https://app.outboundpro.com.br/api","description":"Produção"}],"security":[{"TokenAuth":[]}],"components":{"securitySchemes":{"TokenAuth":{"type":"apiKey","in":"header","name":"Token","description":"Chave privada do cliente (`cli_chave_privada`). Formato UUID v4\n(36 caracteres com hífens). Aceita header em qualquer case\n(`Token`, `token`, `TOKEN`).\n"}},"responses":{"Unauthorized":{"description":"Token ausente, inválido ou cliente inativo.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Recurso não encontrado. Pode ser por:\n- ID inexistente.\n- ID existe **em outro cliente** (isolamento de tenant retorna 404, não 403).\n- Recurso foi deletado/soft-deleted.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"ErrorResponse":{"type":"object","required":["response"],"properties":{"response":{"type":"string","enum":["error"]},"mensagem":{"type":"string","description":"Descrição do erro em pt-BR. Família Contact usa `message` (legado)."},"message":{"type":"string","description":"Equivalente inglês de `mensagem`, usado pela família Contact."}}}}},"paths":{"/lead/detail":{"get":{"tags":["Lead"],"summary":"Detalhar 1 lead","operationId":"leadDetail","description":"Retorna **todos os campos** de um lead específico — endereço completo,\nsócios (contatos), CNAEs secundários, tags, scoring, status, lista,\npróximas ações. É a fonte de verdade pra puxar o estado atual de um\nregistro depois de qualquer operação de modificação.\n\nUse após obter `id` de [`lead/list`](#operation/leadList) ou\n[`lead/search`](#operation/leadSearch).\n\n### Quando usar\n- **Tela de detalhes** no CRM externo — usuário clica num registro e\n o sistema chama esse endpoint pra mostrar tudo numa página.\n- **Pós-modificação** — após `/contact/create`, `/edit` ou qualquer mudança,\n chama aqui pra refrescar o estado completo.\n- **Validação pré-action** — antes de mandar e-mail/WhatsApp, confere\n que o lead ainda tem os contatos válidos.\n\n### Quando NÃO usar\n- **Listar vários** — use `/lead/list` ou `/lead/search`. Detail é por ID único.\n- **Cache local** — os dados mudam (sócios podem ser atualizados pelo painel\n ou outras integrações). Sempre busca antes de operar.\n\n### Casos de uso reais\n- **Salesforce Lightning component**: ao abrir registro, faz call → mostra\n cards de sócios + telefones + emails + scoring lado a lado.\n- **Workflow de qualificação**: ao mover lead de status no CRM externo, chama\n aqui pra ver scoring + tags + última prospecção, decide se vai pra \"qualificado\".\n- **WhatsApp bot**: bot recebe número de CNPJ no chat, busca o lead, mostra\n resumo dos sócios e telefones pra equipe comercial.\n","parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"integer"},"description":"ID do lead (`emp_codigo`)."}],"responses":{"200":{"description":"Detalhes completos do lead.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"string","enum":["success"]},"empresa":{"type":"object","description":"Payload completo (snake_case interno)."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}} ```