Paginação

Percorra listas longas na API do BoxHero com paginação baseada em cursor.

Os endpoints de listagem retornam os resultados uma página por vez e usam paginação baseada em cursor.

Parâmetros de consulta

Parâmetro	Descrição
`cursor`	Onde a página começa. Passe o campo `cursor` da resposta anterior. Omita-o na primeira chamada.
`limit`	Tamanho da página. O intervalo permitido e o valor padrão estão listados em cada endpoint, por exemplo Listar itens.

Resposta

Cada página traz os resultados junto com os campos necessários para buscar a próxima:

{
  "items": [...],
  "count": 100,
  "limit": 100,
  "cursor": 1234567,
  "has_more": true
}

Campo	Descrição
`count`	Número de resultados nesta página
`limit`	Tamanho de página usado nesta página
`cursor`	Passe este valor como o parâmetro de consulta `cursor` para obter a próxima página. `null` quando não há mais páginas.
`has_more`	`true` se houver mais resultados depois desta página

Como buscar todas as páginas

Chame o endpoint de listagem sem cursor.
Enquanto has_more for true, chame-o novamente com cursor definido como o cursor da última resposta.
Pare quando has_more for false.

curl "https://rest.boxhero-app.com/v1/items?cursor=1234567" \
  -H "Authorization: Bearer $BOXHERO_API_TOKEN"

Mantenha os mesmos filtros usados na primeira chamada em todas as chamadas seguintes.

Ordenação

Cada recurso define a sua própria ordem. A maioria dos endpoints de listagem retorna os resultados por id, em ordem crescente. Listar transações retorna primeiro as transações mais recentes (por data e hora da transação, usando o id como critério de desempate).