Listagem, Paginação e Ordenação

As endpoints que retornam listas são, por padrão, paginadas.

Seu retorno sempre segue a seguinte estrutura JSON:

Exemplo de Response Paginada

{
    "data": [
        {
            "id": 1,
           ...
        }
    ],
    "pagination": {
        "page": 1,
        "pagesCount": 10,
        "perPage": 10
    }
}

Utilizando os parâmetros page, perPage, sort e order você pode navegar entre as páginas e ordenar os registros conforme desejar, da seguinte forma:

• page: parâmetro que indica a página que deseja filtrar
  • (ex: /api/companies?page=1)
• perPage: parâmetro que indica quantos registro por página deseja trazer (ex: 10)
  • (ex: /api/companies?page=1&perPage=10)
• sort: parâmetro que indica o campo que deseja realizar a ordenação (ex: id)
  • (ex: /api/companies?page=1&perPage=10&sort=id)
• order: parâmetro que indica se a ordenação é ascendente ou descendente (ex: asc para ordem crescente ou desc para ordem decrescente)
  • (ex: /api/companies?page=1&perPage=10&sort=id&order=asc)