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

​
page_size
integer

The of items in the current page

​
page
integer

The number of the current page. 1 based index

​
total_items
integer

The total number of items

​
total_pages
integer

The total number of pages

​
has_next_page
boolean

Whether there is a next page of results

​
has_previous_page
boolean

Whether there is a previous page of results

​
links
object

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

​
first
integer

A url to retrieve the first page of results

​
last
string

A url to retrieve the last page of results

​
next
string

A url to retrieve the next page of results, null if there is no next page

​
previous
string

A url to retrieve the previous page of results, null if there is no previous page

​
items
Array<T>

An array of the items requested

Was this page helpful?

Suggest editsRaise issue
AuthenticationSorting