Some responses return a list of resources. If the list is long, the API returns multiple pages of results along with the below paging information. All lists will be capped at 10,000 total items in the response.
Property | Type | Description |
---|---|---|
page | integer | Current page number. Zero-indexed, so the first page is 0. |
numPages | integer | Total number of pages. |
pageSize | integer | Number of resources returned in this page. |
total | integer | Total number of items in each page. Max will be 10,000. |
start | integer | Position in the overall list of the first item on the current page. |
end | integer | Position in the overall list of the last item on the current page. |
nextPageUri | integer | URI for the next page of the resource. |