Parameters
Include these query parameters to page through results:| Parameter | Description |
|---|---|
page[size] | Number of results per page. Default: 20. Maximum: 100. |
page[after] | Cursor pointing to the start of the next page. Omit this parameter on your first request. |
How It Works
When a response includes more results than fit on a single page, the response includes alinks.next value containing a cursor.
Pass the cursor from that value as page[after] in your next request.
-
Make your first request:
-
Check the response for
links.next: -
Pass the cursor from
links.nextaspage[after]in your next request: -
Repeat until
links.nextisnull, which indicates that you have reached the last page.
Working with Cursors
- Cursors are opaque strings. Treat them as values to pass through, not as values to parse or construct.
- Cursors are not guaranteed to be stable across sessions. Retrieve a fresh cursor for each pagination sequence.