Skip to main content

Pagination

All top-level API list handler resources support bulk fetching of information through pagination. The GET handlers share a common set of query parameters and response fields.

Common Query Parameters

NameDescription
pageReturn results for the specified page number
pageLimitThe number of results to include with each page. The default is 50 and the maximum is 500.
startDateThe start date for records to be included. This must be formatted YYYY-MM-DD.
endDateThe end date for records to be included. This must be formatted YYYY-MM-DD.

Common Response Fields

NameDescription
first_page_uriThe URI for the first page of results for the resource
previous_page_uriThe URI for the previous page of results. This URI is null when fetching the first page of results
next_page_uriThe URI for the next page of of results. This URI is null when no additional results are available.
pageThe current page number. The first page index is 0
page_limitThe maximum number of results that will be included in each page
page_sizeThe number of pages of results
resultsThe set of results for the particular page