Documentação da API LeadCNPJ

Endpoints · Sistema

Consulta os agentes e condições de operação

Agentes do titular na conta da chave. Informa status, homologação, canal, saldo e instantes de atividade. Os instantes de produção excluem as linhas de homologação identificadas na fila. proximo_disparo_em é planejamento, não confirmação de envio; canal conectado não comprova execução do cron. Não expõe prompts, credenciais ou mensagens.

Parâmetros

Nome	Em	Obrigatório	Descrição
page	query	não
per_page	query	não
status	query	não

Respostas

Status	Descrição
200	Dados do sistema. meta.creditos_consumidos é sempre 0; datas sem fuso usam America/Sao_Paulo.
401	Chave inválida ou revogada.
403	Finalidade, conta, papel ou plano não permitem o acesso.
404	Recurso ausente ou fora da visão do titular.
405	A API do sistema aceita apenas GET.
422	Parâmetros inválidos.
429	Limite de chamadas atingido.
500	Leitura indisponível. Não representa saldo ou total zero.

Exemplo curl

curl -H "Authorization: Bearer leadcnpj_system_..." \
     https://leadcnpj.com.br/api/v1/sistema/agentes

Exemplo de resultado (200)

Dados fictícios. Campos sem informação podem ser null.

{
    "data": [
        {
            "id": 45,
            "nome": "Sara",
            "tipo": "sdr",
            "objetivo": "agendar_reuniao",
            "status": "ativa",
            "validado_em": "2026-10-15 10:00:00",
            "em_homologacao": false,
            "canal": {
                "id": 3,
                "status": "conectado",
                "conectado": true
            },
            "saldo_creditos": 677,
            "ultima_resposta_em": null,
            "ultimo_disparo_em": null,
            "proximo_disparo_em": null,
            "criado_em": "2026-10-15 09:00:00"
        }
    ],
    "meta": {
        "creditos_consumidos": 0,
        "consultado_em": "2026-10-16T08:00:00-03:00",
        "timezone": "America/Sao_Paulo",
        "page": 1,
        "per_page": 25,
        "total": 1,
        "has_more": false
    }
}