OPEN NAVIGATION MENU

Pagination

Learn how to use pagination to manage responses

Many endpoints are paginated, meaning that only a certain number of resources will be returned at a time. There is no default, each endpoint has its limit of resources returned at a time (note also that the limit is not overridable).
The response from an endpoint, which is paginated, looks like the example below.

If the endpoint is not paginated, the pagination field is not returned at all.

  
      {
  "data": [],
  "pagination": {
    "page": 1,
    "itemsPerPage": 20,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}
    
  

The page field represents the current page. The itemsPerPage field represents the maximum limit of resources returned at a time for that endpoint. The hasNextPage is a boolean and indicates whether or not there are more resources matching the query. If true, you may want to make subsequent requests to retrieve the other resources. The hasPrevPage is always true when the page is greater than 1.
To change the page, pass the parameter page as a query parameter in the call to the enpoints.