{
  "meta": {
    "page_size": "integer",
    "page": "integer",
    "total_items": "integer",
    "total_pages": "integer",
    "has_next_page": "boolean",
    "has_previous_page": "boolean"
  },
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "previous": "string"
  },
  "items": []
}

Endpoints that return a collection of results are always paginated. Paginated results will return a PagedResponse<T>[] object. The objects contains meta, links and items properties.

​
Paginated request

​
page
integer
default:"1"

The number of the page to return.

​
page_size
integer
default:"30"

The number of items to return. Defaults to 30. Min = 1. Max = 100

​
Paginated response

​
meta
object

Contains information about the number of results and pages

​
links
object

Useful links to get the first/last and next/previous page of results

​
items
Array<T>

An array of the items requested

{
  "meta": {
    "page_size": "integer",
    "page": "integer",
    "total_items": "integer",
    "total_pages": "integer",
    "has_next_page": "boolean",
    "has_previous_page": "boolean"
  },
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "previous": "string"
  },
  "items": []
}