Paginação

A API pública da Jump aplica paginação consistente em endpoints que retornam listas de recursos.

Como a paginação funciona

• Todas as listas paginadas utilizam um tamanho fixo de 10 itens por página (perPage).
• A página desejada é informada via query string com o parâmetro page (padrão: 1).
• A resposta inclui metadados que permitem identificar a página atual e o total de páginas disponíveis.

:::info Campos em camelCase A API converte as chaves do JSON de resposta para camelCase (ex.: perPage) — mesmo que internamente o backend use snake_case. :::

Parâmetro de consulta

Nome	Tipo	Obrigatório	Padrão	Descrição
page	number	Não	1	Número da página solicitada (inicia em 1).

Valores ausentes, não numéricos ou menores que 1 são tratados como 1.

Exemplo de requisição

curl -X GET "$JUMP_API_BASE_URL/api/{userId}/establishment/{establishmentId}/clients?page=2" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Accept: application/json"

Formato da resposta

Endpoints paginados retornam o payload dentro de data, seguindo o envelope padrão da API (consulte Autorização para o formato geral de sucesso e erro). Os campos específicos da paginação são:

Campo	Tipo	Descrição
content	array	Itens da página atual.
total	number	Total de itens considerando todos os filtros aplicados.
perPage	number	Quantidade de itens por página (10).
currentPage	number	Página atual retornada.
lastPage	number	Última página disponível para a consulta.

Exemplo de resposta (JSON)

{
  "response": "success",
  "data": {
    "content": [
      { "id": 1, "name": "Recurso A" },
      { "id": 2, "name": "Recurso B" }
    ],
    "total": 47,
    "perPage": 10,
    "currentPage": 2,
    "lastPage": 5
  }
}

Navegação entre páginas

• A primeira página é sempre 1.
• Utilize lastPage para saber quando a coleção foi totalmente percorrida.
• Quando currentPage é igual a lastPage, não há mais páginas a serem consultadas.
• Solicitar uma page maior que lastPage retorna content vazio, mantendo os demais metadados consistentes.

Boas práticas

• Sempre trate lastPage para evitar requisições desnecessárias a páginas inexistentes.
• Combine a paginação com os filtros do endpoint para reduzir o volume de dados percorrido.
• Respeite o Rate Limit ao percorrer todas as páginas de coleções grandes; considere pequenas pausas ou processamento em lote.