Pagination

For endpoints that return multiple resources, such as list style endpoints, a common set of query parameters and a common response format are provided to allow for quick pagination of data.

Request query parameters

Use the following query parameters to paginate through data:

Parameter	Default	Description
limit	10	The number of resources to return (Maximum 30).
offset	0	the number of resources to offset the request by.

Response format

All endpoints which can return multiple resources will have responses structured as follows:

{
  "data": [], # An array of the requested resources
  "pagination": {
    "has_more": true
    "in": 10, # A count of the resources in the data array
    "offset": 0, # The offset used in returning the resources (not necessarily what you requested)
  }
}