Visao geral
A API da LiderHub esta em fase beta . Para utilizar, é necessário solicitar a liberação de acesso para o seu workspace.
Nesta secao, voce encontra a referencia da API da LiderHub para integrar seu workspace com sistemas externos.
Com a API, voce pode:
consultar conversas e contatos;
listar conexoes e configuracoes do workspace;
gerenciar grupos do WhatsApp;
enviar mensagens;
integrar automações com seus sistemas internos.
Rate Limit
A API possui um limite de 3 requisições por segundo por workspace. Requisições que excederem esse limite receberão o status HTTP 429 Too Many Requests.
Para evitar erros de rate limit, implemente um mecanismo de retry com backoff exponencial nas suas integrações.
Códigos de erro
A API retorna erros padronizados em formato JSON. Abaixo estão os principais códigos de status e suas causas.
400 Bad Request
Erro de validação ou parâmetros inválidos.
Causa Descrição Validação falhou Parâmetros não passaram na validação (formato, tipo, etc.) UUID inválido ID informado não está no formato UUID válido Conexão inválida Contato não possui conexão WhatsApp vinculada Conexão fechada WhatsApp está desconectado Janela expirada Janela de 24 horas do WhatsApp expirou
401 Unauthorized
Erro de autenticação com a chave de API.
Causa Descrição Header ausente O header x-company-key não foi enviado Chave inválida A chave de API não existe ou está incorreta Sem permissão A chave não tem permissão para acessar este endpoint Chave expirada A chave de API expirou Chave desabilitada A chave de API foi desabilitada
404 Not Found
Recurso não encontrado no workspace.
Causa Descrição Contato não encontrado O ID do contato informado não existe Mensagem não encontrada O ID da mensagem informado não existe Conexão não encontrada O ID da conexão informado não existe Contato fora do workspace O contato não existe ou não pertence ao workspace
429 Too Many Requests
Limite de requisições excedido.
Causa Descrição Rate limit excedido Limite de requisições por segundo foi ultrapassado
500 Internal Server Error
Erro interno do servidor.
Causa Descrição Erro inesperado Erro não tratado no servidor
503 Service Unavailable
Serviço temporariamente indisponível.
Causa Descrição Serviço indisponível Sistema de autenticação ou outro serviço está fora do ar
Formato da resposta de erro
Todas as respostas de erro seguem o formato:
{
"statusCode" : 400 ,
"message" : "Validation failed" ,
"timestamp" : "2026-03-25T17:30:00.000Z" ,
"path" : "/v1/contacts"
}
Para erros de validação, o campo errors detalha cada problema:
{
"statusCode" : 400 ,
"message" : "Validation failed" ,
"timestamp" : "2026-03-25T17:30:00.000Z" ,
"path" : "/v1/contacts" ,
"errors" : [
{
"field" : "createdAfter" ,
"message" : "createdAfter must be a valid ISO 8601 date string"
}
]
}
Solicitar acesso
Durante o beta, o acesso é controlado por liberação. Se você ainda não possui a chave de autenticação, preencha o formulário abaixo para solicitar habilitação.
Exemplo: enviar lead para N8N Passo a passo completo de uma Custom Tool que envia dados do lead para o N8N via webhook.
Deixe uma sugestao
Feedback de Melhorias sobre API da LiderHub
Agradecemos muito pelo seu tempo! Se voce precisa de suporte, acesse Obtenha suporte .