Documentação da API

Integre o LukaLead com suas ferramentas favoritas. Use nossa API REST para buscar leads e automatizar seu fluxo de trabalho.

Esta chave será usada automaticamente em todos os exemplos interativos abaixo. Ela é salva apenas no seu navegador.

Autenticação

A API do LukaLead usa chaves de API para autenticar requisições. Você pode ver e gerenciar suas chaves na página de Configurações.

Sua chave de API carrega muitos privilégios, então certifique-se de mantê-la segura! Não compartilhe sua chave secreta em áreas publicamente acessíveis como GitHub, código do lado do cliente, etc.

A autenticação é feita via cabeçalho HTTP Authorization ou X-API-Key.

Authorization: Bearer luk_live_...

Endpoints

GET

/api/v1/searches

Listar Pesquisas

Retorna uma lista paginada de todas as suas pesquisas salvas. As pesquisas são ordenadas por data de criação (mais recentes primeiro).

Parâmetros

page
O número da página para retornar.
integer
limit
O número de itens por página (máx 100).
integer
GET

/api/v1/searches/{id}/leads

Listar Leads de uma Pesquisa

Retorna os leads encontrados para uma pesquisa específica. Inclui informações como nome, cargo, empresa e pontuação de match.

Parâmetros

id*
O ID único da pesquisa.
uuid
page
O número da página para retornar.
integer
limit
O número de itens por página (máx 100).
integer