Pagination

Certain endpoints are paginated. Paginated endpoints all use two parameters, page and page_size to paginate through a list of results and respond with the same set of pagination headers.

Paginated request parameters

ParameterTypeDefaultDescription
pageinteger1Page of results to display
page_sizeinteger(endpoint-specific)Number of results to return per page; maximum: (endpoint-specific)

Paginated response headers

HeaderDescription
X-Total-PagesTotal pages
X-Current-PageCurrent page
X-Per-PageThe maximum number of results per page
X-Total-ResultsThe total number of results