Pagination

Where an end point returns a list of objects, we follow a standard pagination model across all APIs that provide a list of responses. A links object provides access to the current (self) page, first, last, next and previous.

You can manage how many results are returned per page and which page of results you wish to view by updating request parameters page and page_size.

Links

Link	Description
`self`	'Self' refers to the current page of results.
`first`	'First' refers to the first page of results. 'First' is always page 0.
`prev`	'Prev' refers to the previous page of results. If 'self' is page 1, 'prev' is page 0.
`next`	'Next' refers to the next page of results. If 'self' is page 1, 'next' is page 2.
`last`	'Last' refers to the last page of results. If there are 3 pages in total, 'last' is page 2.

Parameters

Parameter	Description
`page`	Refers to the page of results to be returned by the request.
`page_size`	Refers to the number of results to be returned by the request.

Example

Copy

Copied

{
  	"data": {
  		...
  	},
  	"links": {
		"self": "/v1/applications?page=0&page_size=10&order=DESC&order_by=created_date",
		"first": "/v1/applications?page=0&page_size=10&order=DESC&order_by=created_date",
		"prev": "/v1/applications?page=0&page_size=10&order=DESC&order_by=created_date",
		"next": "/v1/applications?page=1&page_size=10&order=DESC&order_by=created_date",
		"last": "/v1/applications?page=2&page_size=10&order=DESC&order_by=created_date"
  	}
}