Skip to content

Paginação

Endpoints de listagem não devolvem tudo de uma vez. Há duas formas de paginar, conforme o recurso.

Por página (page)

A maioria das listas (contatos, conversas, funis, cards, agendamentos…) aceita o parâmetro page:

bash
curl "https://appchat01.interleads.chat/api/v1/accounts/3/contacts?page=2" \
  -H "api_access_token: $INTERLEADS_TOKEN"

Percorra as páginas incrementando page (1, 2, 3…) até a resposta vir vazia.

O formato da resposta varia por recurso

Alguns recursos embrulham os itens em um campo (payload ou data) e trazem um bloco meta com contadores; outros devolvem o array direto. Confira o corpo da resposta do recurso que você está usando para saber onde estão os itens e o total.

Por cursor de mensagem (before / after)

As Mensagens de uma conversa paginam por ID de mensagem, não por número de página:

  • before=<id> — carrega mensagens anteriores ao ID (histórico mais antigo);
  • after=<id> — carrega mensagens posteriores ao ID (mais recentes).
bash
# 20 mensagens anteriores à mensagem 9001
curl "https://appchat01.interleads.chat/api/v1/accounts/3/conversations/123/messages?before=9001" \
  -H "api_access_token: $INTERLEADS_TOKEN"

Boas práticas

  • Não presuma um tamanho de página fixo — trate o fim da lista pela resposta vazia ou pelos contadores de meta.
  • Para varreduras grandes, prefira filtros (por status, inbox_id, data etc.) a paginar a base inteira — menos páginas, menos carga.

Documentação da API — Interleads Chat.