Cursor pagination
Paginated list endpoints use Relay-style cursor pagination instead of offset-based pagination. A cursor represents a specific position in a list.
To page forward:
- Send the first request with
firstset to the page size. - Read the cursor of the last item in the response.
- Send the next request with
afterset to that cursor. - Stop when
pageInfoshows no next page.
To page backward, use last and before. You cannot combine forward and backward parameters in the same request.
Page size
The default page size is 100 items. The maximum page size is 500 items.
Response shape
Paged responses contain three fields:
| Field | Contains |
|---|---|
edges | A list of items. Each item has a cursor and a node. The node is the object. |
pageInfo | Information about the position of this page in the list. |
totalCount | The number of items in the full list. |
Page info
| Field | Contains |
|---|---|
hasNextPage | true if there are more items after this page. |
hasPreviousPage | true if there are more items before this page. |
startCursor | The cursor of the first item on this page, or null if empty. |
endCursor | The cursor of the last item on this page, or null if empty. |
Filtering
Filtering is typically specified using query parameters. See specific resource endpoints to see the available options:
