Endpoint

Consultar lead por ID

Use a consulta por ID quando uma integração precisa recuperar um registro específico, validar detalhe ou reprocessar um lead já conhecido.

GET /public/v1/leads/{lead_id}lead_idread-only

Para que serve

A consulta por ID é útil quando o sistema externo já tem o identificador do lead e precisa conferir o estado atual daquele registro.

O lead precisa pertencer ao escopo associado ao token. Caso contrário, a API deve retornar not_found.

Endpoint

GET /public/v1/leads/{lead_id}

Headers

Authorization: Bearer SEU_TOKEN_AQUI

Parâmetros de rota

Parâmetro	Tipo	Obrigatório	Descrição
lead_id	string	Sim	Identificador do lead retornado pela listagem.

Exemplo de request

GET /public/v1/leads/123

Exemplo de resposta

{
  "data": [
    {
      "id": "123",
      "first_name": "Maria",
      "last_name": "Silva",
      "full_name": "Maria Silva",
      "email": "maria@example.com",
      "phone": "5545999999999",
      "origin": "MANUAL",
      "status": true,
      "subscribed": true,
      "created_at": "2026-05-06T12:00:00Z",
      "updated_at": "2026-05-06T12:30:00Z",
      "deleted": false,
      "deleted_at": null,
      "last_bought": null,
      "total_orders": 0,
      "lead_linkedin_url": null,
      "lead_role": null,
      "lead_type": null,
      "lead_area": null
    }
  ],
  "page_info": {
    "next_cursor": null,
    "has_more": false
  }
}

Quando usar

Use a consulta por ID em reprocessamentos, telas internas de conferência, rotinas de auditoria do integrador ou fallback quando o destino precisa validar um lead pontual.

Para cargas e sincronizações, prefira a listagem com cursor e updated_since.

Erros comuns

Status	Código	Quando acontece	Ação recomendada
401	unauthorized	O token está ausente, inválido ou revogado.	Confira o header Authorization e gere novo token se necessário.
404	not_found	O lead consultado não existe no escopo associado ao token.	Confirme o lead_id e a loja ou conta ligada ao token.
503	integration_disabled	A integração está desabilitada para a conta ou token.	Reative a integração no painel ou fale com o responsável pela conta.
500	internal_error	Ocorreu erro inesperado ao processar a chamada.	Registre horário, endpoint, request_id se houver e tente novamente.