Paginação das respostas da API

Alguns de nossos endpoints possuem paginação. Implementamos paginação para endpoints que tem o potencial de retornar um grande número de resultados.

Neste caso, temos os parâmetros offset e limit para operar sobre a paginação (para determinar a partir de qual entrada o desenvolvedor parceiro gostaria de consultar, e quantos resultados por página devem ser exibidos, respectivamente).

No retorno de endpoints com paginação enviamos o objeto pagination, para consulta e referência do desenvolvedor parceiro.

Todos os nossos endpoints seguem um formato específico. Retornamos os resultados no formato JSON, com os seguintes campos sempre presentes:

• status: Mensagem que representa o estado da resposta. Utilizado para determinar se a requisição foi um sucesso ou se houve falha na requisição.
• data: Campo utilizado para envolver a resposta da requisição.
• pagination: Campo utilizado para referência da paginação, para os endpoints que se utilizam de paginação.

Exemplo de resposta com paginação

{
  "status": "success",
  "data": {
    ...
  },
  "pagination": {
    "currentOffset": 10,
    "limit": 10,
    "totalItems": 50
  }
}