API REST · v1.2.0

Documentação da API LeadCNPJ

Consulte dados de prospecção ou conecte seu sistema ao CRM: leads, oportunidades, plano, créditos e agentes de IA. Cada finalidade usa uma chave própria.

Visão Geral

Autenticação

Toda requisição precisa do header Authorization com sua chave de API:

Authorization: Bearer leadcnpj_live_<32-char-secret>

Formato da chave

As chaves seguem o padrão:

  • leadcnpj_live_<32-char-secret> — produção (consome créditos reais)
  • leadcnpj_system_<32-char-secret> — leitura do CRM, plano, créditos e agentes, sem consumo de créditos.
  • Chaves legadas leadcnpj_test_ continuam usando os dados e créditos de prospecção; não são um sandbox.

Como criar uma chave

Acesse Configurações → API e clique em "Nova chave". Apenas owner/admin de grupo em plano com API (Growth, Scale, Scale AI ou Enterprise) conseguem criar. A chave em claro é mostrada uma única vez — anote em local seguro.

Recomendação: crie chaves separadas pra cada integração (HubSpot, Zapier, sistema interno) com nome descritivo. Facilita revogar uma sem quebrar as outras.

Erros de autenticação

  • 401 invalid_api_key: chave ausente, formato inválido ou não cadastrada.
  • 401 revoked_api_key: chave foi revogada via painel.
  • 403 plan_does_not_allow_api: plano do dono da chave não inclui API (faça upgrade a partir do Growth).