Pagination

All Search Endpoints are paginated. Direct Endpoints that return a list of results, such as /v1/deployments/\<DeploymentID>/invoices are not paginated as the quantity of results returned are far smaller.

Pagination is managed via Query Parameters.

Parameter

Description

Values

PageNumber

The page number of the results, as a Zero Indexed integer. Enables you to paginate through pages of results by page number. Use in combination with PageSize.

Default: 0

Min: 0

Max: There is no max value

PageSize

Controls how may results will be returned per page

Default: 100

Min: 10

Max: 1000

Paginated Response

The response body to these endpoints are wrapped in pagination metadata.

PropertyDescription
totalItemsThe total number of records available. This is not Zero Indexed
totalPagesThe total number of pages that would be returned based on the given PageSize Parameter. This_is_ Zero Indexed
pageNumberThe current page we are on. This_is_ Zero Indexed
pageSizeThe current number of records on this page
itemsThe array of results