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

Parameter

Type

Default

Description

page

integer

1

Page of results to display

page_size

integer

(endpoint-specific)

Number of results to return per page; maximum: (endpoint-specific)

Paginated response headers

Header

Description

X-Total-Pages

Total pages

X-Current-Page

Current page

X-Per-Page

The maximum number of results per page

X-Total-Results

The total number of results