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

Name Description
page Return results for the specified page number
pageLimit The number of results to include with each page. The default is 50 and the maximum is 500.
startDate The start date for records to be included. This must be formatted YYYY-MM-DD.
endDate The end date for records to be included. This must be formatted YYYY-MM-DD.

Common Response Fields

Name Description
first_page_uri The URI for the first page of results for the resource
previous_page_uri The URI for the previous page of results. This URI is null when fetching the first page of results
next_page_uri The URI for the next page of of results. This URI is null when no additional results are available.
page The current page number. The first page index is 0
page_limit The maximum number of results that will be included in each page
page_size The number of pages of results
results The set of results for the particular page