Pagination

Efficiently Navigate Large Data Sets

Our API employs pagination to efficiently manage large datasets and provide structured access to resources. Endpoints returning lists of resources support the following pagination parameters:


Pagination Parameters

  • page: Specifies the page number to retrieve.
  • perPage: Controls the number of items displayed per page.

Default values are applied for these parameters if they are not specified.


Pagination Response Structure

Each paginated response includes the following metadata:

  • numberOfItems: Total number of items available.
  • numberOfPages: Total number of pages.
  • currentPage: The page number of the current response.
  • results: The list of items on the current page.

Navigating Paginated Results

To retrieve the next page of results, simply increase the page parameter in subsequent API requests. For example:

GET /resources?page=2&perPage=20