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âmetro | Descrição |
|---|---|
| page | Define a página de resultados que será retornada, que por padrão é 1 e o máximo varia com a quantidade de registros da consulta. |
| perPage | Define o tamanho das páginas, que por padrão é 15, tendo um mínimo de 1 e máximo de 200. |
Um exemplo é a URL https://{subdominio}.cxm.pipe.run/api/v2/queues?perPage=5&page=2, onde mostrará 5 filas de atendimento da página 2.
Por padrão, a paginação define para mostrar 15 resultados (limitados a 200) da primeira página conforme abaixo.
?page=2&perPage=5
É 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.