Resource List Pagination

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.

PropertyTypeDescription
pageintegerCurrent page number. Zero-indexed, so the first page is 0.
numPagesintegerTotal number of pages.
pageSizeintegerNumber of resources returned in this page.
totalintegerTotal number of items in each page. Max will be 10,000.
startintegerPosition in the overall list of the first item on the current page.
endintegerPosition in the overall list of the last item on the current page.
nextPageUristringURI for the next page of the resource.