Overview
All list endpoints return paginated results to ensure optimal performance and manageable response sizes.Request Parameters
The page number to retrieve. Pages are 1-indexed.
Number of items per page. Maximum value is 100.
Response Format
Paginated responses include metadata about the results:Response Fields
Field | Type | Description |
---|---|---|
object | string | Always “list” for paginated responses |
data | array | The requested items |
has_more | boolean | Whether more pages exist |
total | integer | Total number of items |
page | integer | Current page number |
per_page | integer | Items per page |
total_pages | integer | Total number of pages |
Examples
Basic Pagination
Request the first page with default page size:Custom Page Size
Request 20 items per page:Navigate to Specific Page
Get page 3 of results:Best Practices
Choose Appropriate Page Size
Choose Appropriate Page Size
- Use smaller page sizes (10-20) for real-time UIs
- Use larger page sizes (50-100) for batch processing
- Consider network latency and processing time
Handle Edge Cases
Handle Edge Cases
- Check
has_more
before fetching next page - Handle empty results gracefully
- Validate page numbers are within range
Implement Cursor Pagination
Implement Cursor Pagination
For frequently changing data:
- Store the last item ID from each page
- Use filters to get items after that ID
- Prevents missing items due to insertions
Code Examples
Performance Tips
- Cache Results: Store paginated results when data doesn’t change frequently
- Parallel Requests: Fetch multiple pages simultaneously when order doesn’t matter
- Progressive Loading: Load initial page quickly, fetch more as needed
- Use Filters: Combine pagination with filters to reduce dataset size