API documentation
Pagination
List endpoints use cursor-based pagination for consistent and reliable page traversal.
Request parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
cursor | string | null | Opaque cursor from the previous page response |
per_page | integer (1-100) | 20 | Number of items per page |
Response format
{
"data": [...],
"pagination": {
"next_cursor": "opaque_cursor_value",
"has_more": false
}
}
| Field | Type | Description |
|---|---|---|
data | array | Page of results |
pagination.next_cursor | string or null | Cursor for the next page (null when no more results) |
pagination.has_more | boolean | Whether additional pages exist |
Usage
- Make an initial request without a
cursorparameter. - Use
pagination.next_cursorfrom the response as thecursorparameter in the next request. - Repeat until
next_cursorisnullorhas_moreisfalse.
Cursor handling
- Treat cursors as opaque strings: store and return them unchanged, without parsing or modifying them.
- Keep
per_pageconsistent while traversing a result set to avoid unexpected page boundaries. - Invalid or modified cursors are rejected with a
422 Validation Error.