API Reference

Paginação

Todo endpoint de consulta que retorna uma lista segue o mesmo modelo de paginação.

  1. GET request aceita os seguintes parâmetros de query:
ParâmetroTipoDescrição
countinteiroNúmero máximo de resultados a serem retornados na resposta
pageinteiroNúmero da página
  1. Na response retornam os headers
X-Total-PagesinteiroNúmero máximo que pode ser especificado no parâmetro count da requisição. Exemplo se existem 110 registros ao todo e count == 10, então X-Total-Pages == 11
X-Total-ItemsinteiroNúmero de registros desse recurso.
X-CountinteiroValor espelhado do parâmetro count da requisição.
X-PageinteiroValor espelhado do parâmetro page da requisição.