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
The number of the page to return.
The number of items to return. Defaults to 30. Min = 1. Max = 100
Paginated response
Contains information about the number of results and pages The of items in the current page
The number of the current page. 1 based index
The total number of items
The total number of pages
Whether there is a next page of results
Whether there is a previous page of results
Useful links to get the first/last and next/previous page of results A url to retrieve the first page of results
A url to retrieve the last page of results
A url to retrieve the next page of results, null if there is no next page
A url to retrieve the previous page of results, null if there is no previous page
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" : []
}