Home
Advocacy API

Pagination

Page through collections with pagination links.

We limit the number of resources returned in a response to a subset of the whole set available and provide links to traverse it. Pagination links (self, first, prev and next) appear in the top-level links object that corresponds to a collection. prev and next are omitted when there is no previous or next page.

Most collections use page[size] to set the number of resources per page (25 by default) and page[number] to select a page. Some collections, such as posts, use opaque cursors (page[before] and page[after]) instead; follow the pagination links rather than building cursors yourself.

For example:

GET /v2/teams/1/experiences?page[size]=50&page[number]=2 HTTP/1.1
Accept: application/vnd.api+json