Paginação de consultas

A paginação permite limitar o número de resultados que obtém como resposta da requisição.

Se a rota da requisição é paginada, acrescente uma string de consulta na requisição para especificar os parâmetros de paginação.

A paginação possui dois operadores básicos que serão utilizados em conjunto durante as requisições:

ParâmetroDescrição
showDefine o tamanho das páginas, que por padrão é 15, tendo um mínimo de 1 e máximo de 200.
pageDefine a página de resultados que será retornada, que por padrão é 1 e o máximo varia com a quantidade de registros na conta em voga.

Um exemplo é a URL https://api.pipe.run/v1/users?show=20&page=5, onde mostrará 20 usuários da página 5.

Por padrão, a paginação define para mostrar 15 resultados (limitados a 200) da primeira página conforme abaixo.

?show=15&page=1

É possível também especificar somente um dos parâmetros na string de consulta e o outro parâmetro será carregado com o valor padrão.