limit and offset query parameters across all list endpoints.
Quick Start
How It Works
| Parameter | Type | Default | Range | Description |
|---|---|---|---|---|
limit | int | 50 | 1–200 | Maximum items to return |
offset | int | 0 | ≥ 0 | Number of items to skip |
Paginated Endpoints
All platform list endpoints support pagination:| Endpoint | Description | Default Limit | Max Limit |
|---|---|---|---|
GET /api/v1/workspaces/ | List workspaces | 50 | 200 |
GET /api/v1/workspaces/{ws_id}/projects/ | List projects | 50 | 200 |
GET /api/v1/workspaces/{ws_id}/issues/ | List issues | 50 | 200 |
GET /api/v1/workspaces/{ws_id}/agents/ | List agents | 50 | 200 |
GET /api/v1/workspaces/{ws_id}/activity | List activities | 50 | 200 |
GET /api/v1/workspaces/{ws_id}/issues/{id}/activity | List issue activities | 50 | 200 |
Common Patterns
- Python SDK
- JavaScript
- cURL Script
Best Practices
Choose appropriate page sizes
Choose appropriate page sizes
Use larger page sizes (100-200) for bulk operations, smaller sizes (10-50) for user interfaces. Consider network latency and memory constraints.
Handle empty responses
Handle empty responses
Always check for empty arrays
[] to detect the end of results. Don’t rely solely on response length being less than the page size.Implement retry logic
Implement retry logic
Add exponential backoff for failed requests and timeout handling for reliable pagination in production environments.
Cache total counts separately
Cache total counts separately
Pagination doesn’t return total counts. If needed, make separate count requests or cache totals to avoid expensive calculations.
Testing
Test pagination behavior with these commands:Related
API Authentication
Learn how to authenticate API requests
Error Handling
Handle API errors and rate limits

