Endpoints that return lists of objects support page-based pagination requests.

Request

ParameterTypeDescription
numbernumberThe page number
sizenumberThe number of items to include in the response.
Default is 50, max is 100. If a number above max is passed, default will be returned.

For example, a GET request will contain query parameters like, ?page[number]=1&?page[size]=10. POST requests that use pagination require the page object in the request body:

{
  "page": {
    "number": 2,
    "size": 10
  }
}

Response

In the example below there are 40 items total, broken down in 4 pages of 10 items each.

{
  "data": [ "..." ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 4,
      "total_item_count": 40
    }
  }
}