Paginação

As requisições de listagem retornam em páginas de até 100 registros. Nessa API a estratégia de paginação utilizada é baseada em cursor e consiste no seguinte:

• Cada página é identificada por um parâmetro chamado cursor
• Cada página contém o cursor para próxima e para a anterior através dos atributos next_cursor e prev_cursor, respectivamente.
• Dessa forma não é possível que a aplicação cliente acesse uma página específica (por exemplo page=7), necessitando percorrer as páginas sequencialmente; entretanto esse tipo de paginação oferece vantagens de desempenho em grandes conjuntos de dados e possui tempo de resposta semelhante independente da página solicitada.
• Originalmente, na paginação baseada em cursor, não há o conceito do número total de páginas ou de total de registros na listagem, entretanto, para facilidade de uso, foi adicionado a essa API uma rota para consulta do número total de registros, bastando requisitar a rota de listagem adicionando o sufixo /count na URL.