Skip to main content
Todo GET de lista é paginado. Você escolhe a página com dois parâmetros de query, e o meta da resposta informa se existem mais páginas.
integer
padrão:"1"
Número da página, começando em 1. Um valor inválido ou menor que 1 volta para o padrão.
integer
padrão:"20"
Quantidade de itens por página. O limite padrão é 100. Se você pedir mais, recebe 100, sem erro.

O meta

integer
A página que você recebeu.
integer
Quantidade de itens por página aplicada de fato, já considerando o limite.
boolean
true quando existem registros depois desta página.

Total de registros

O meta não informa o total de registros nem o total de páginas. Para saber se existe outra página, use hasMore. Se você precisa exibir uma contagem na tela, some os itens recebidos enquanto percorre as páginas.

Percorrendo tudo

Para ler todos os registros, avance page enquanto hasMore for true.
Uma varredura completa consome uma requisição por página, e cada uma conta no limite por minuto. Com perPage=100, você gasta 1 requisição a cada 100 registros. Antes de aumentar a frequência do laço, suba o perPage.

Cuidado com dados que mudam

Cada página é calculada no momento da requisição, a partir da posição dos registros (page × perPage). Se registros forem criados ou removidos entre uma página e outra, um item pode aparecer duas vezes ou ficar de fora da varredura. Para exportações que precisam ser exatas:
  • Use um período fixo de datas quando o endpoint aceitar filtro por período.
  • Remova duplicados pelo id ao juntar os resultados.
  • Rode a varredura em um horário de menor movimento.