Pagination

Certain methods return results in a paginated format. The structure of a paginated result is as follows:

{
    "items": [
        ...
    ],
    "totalPages": ...,
    "totalItems": ...,
    "itemsPerPage": ...,
    "nextPage": ...,
    "previousPage": ...
}

The keys nextPage and previousPage will be omitted if there are no next or previous items respectively.

The nextPage and previousPage values can be added to the query parameters of the original query under the page key to get to the next or previous page.

Example

You make a GET request to a paginated endpoint https://api.example.com/foo/bar, and receive the following response:

Copy

{
  "items": [],
  "nextPage": "next-page-number"
}

In order to get the next page of results, you would take the ID at position .nextPage in the response body, and provide it as the value of the page key in a query to the same endpoint. The full URL including query parameters of your request to get the next page of the listing is:

https://api.example.com/foo/bar?page=next-page-number