Conceitos

Paginação

Como paginar os endpoints de lista da API v1 com os parâmetros limit e offset.

Os endpoints de lista da API v1 (como GET /api/v1/tasks e GET /api/v1/orders) aceitam paginação por query string com os parâmetros limit e offset.

Parâmetros

Parâmetro	Tipo	Default	Máximo	Descrição
`limit`	inteiro	`20`	`100`	Quantidade de itens por página
`offset`	inteiro	`0`	—	Quantos itens pular antes de começar

Exemplo de request

Segunda página de 50 tasks (itens 51 a 100):

cURL

curl "https://avatrix.io/api/v1/tasks?limit=50&offset=50" \
  -H "Authorization: Bearer av_xxxxxxxxxxxxxxxx"

GET /api/v1/tasks também aceita o filtro ?status= (por exemplo ?status=completed), combinável com limit/offset:

cURL

curl "https://avatrix.io/api/v1/tasks?status=completed&limit=20&offset=0" \
  -H "Authorization: Bearer av_xxxxxxxxxxxxxxxx"

Para avançar pelas páginas, incremente o offset em passos do tamanho do limit até que a lista retornada venha vazia.