Endpoint

Listar leads pela API

GET /public/v1/leads lista leads/clientes associados ao token e serve tanto para carga inicial quanto para sincronizações recorrentes.

GET /public/v1/leadslimitupdated_since

Para que serve

Use este endpoint para buscar leads em lote. Ele é a base para integrações com CRM, ERP, n8n, planilhas, BI e sistemas próprios.

A API é somente leitura: a chamada lista registros, mas não cria, edita ou remove dados.

Endpoint

GET /public/v1/leads

Headers

Authorization: Bearer SEU_TOKEN_AQUI

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
limit	number	Não	Define a quantidade de registros retornados em uma página.
cursor	string	Não	Continua a paginação a partir de page_info.next_cursor.
updated_since	ISO 8601 datetime	Não	Busca leads novos ou atualizados desde uma data.
include_deleted	boolean	Não	Inclui registros removidos ou inativados quando aplicável.

Exemplo de request

curl -X GET "URL_DA_API/public/v1/leads?limit=100" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI"

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
  }
}

Carga inicial

Na primeira sincronização, chame a listagem sem updated_since para montar a base inicial. Continue usando page_info.next_cursor enquanto has_more for true.

Sincronização incremental

Nas execuções seguintes, use updated_since para buscar apenas registros novos ou atualizados. Se quiser processar removidos ou inativados quando aplicável, inclua include_deleted=true.

Ver guia incremental

Erros comuns

Status	Código	Quando acontece	Ação recomendada
400	invalid_parameter	Um parâmetro não reconhecido ou incompatível foi enviado.	Revise nomes, tipos e combinação de parâmetros.
400	invalid_cursor	O cursor informado não pode ser lido ou não pertence à consulta atual.	Use apenas o valor retornado em page_info.next_cursor.
400	invalid_updated_since	A data de updated_since não está em formato aceito.	Envie uma data ISO 8601, por exemplo 2026-05-06T00:00:00Z.
400	invalid_limit	O limit está fora do intervalo aceito ou não é numérico.	Ajuste o tamanho da página antes de repetir a chamada.
401	unauthorized	O token está ausente, inválido ou revogado.	Confira o header Authorization e gere novo token se necessário.