Climatools Support Portaal

Lijsten met veel resultaten krijg je niet in één keer terug, maar in pagina’s. In dit artikel lees je hoe je door die pagina’s bladert en welke gegevens je daarbij terugkrijgt.

Hoe blader ik door de resultaten?

Lijst-endpoints zoals GET /api/relations of GET /api/companies zijn gepagineerd. Gebruik de query parameter page om door de resultaten te bladeren:

GET /api/companies?page=2

Welke paginagegevens krijg ik terug?

Naast de data (data) krijg je ook een meta-object terug met paginagegevens:

{
  "data": [ ... ],
  "meta": {
    "totalItems": 42,
    "itemsPerPage": 30,
    "currentPage": 1
  }
}

In het meta-object zie je:

• totalItems: het totale aantal items.

• itemsPerPage: het aantal items per pagina.

• currentPage: de pagina die je hebt opgevraagd.