Query parameters
| Parameter | Type | Default | Max | Description |
|---|---|---|---|---|
page | integer | 1 | — | Page number (1-indexed) |
limit | integer | 20 | 100 | Items per page |
Response format
Every paginated response includes apagination object:
| Field | Description |
|---|---|
page | Current page number |
limit | Items per page |
total | Total number of items across all pages |
pages | Total number of pages |
Examples
First page (default)
Specific page with custom limit
Fetch all pages
To retrieve all records, iterate through pages untilpage >= pages:
Paginated endpoints
The following endpoints support pagination:| Endpoint | Default order |
|---|---|
GET /v1/agents | Created date (newest first) |
GET /v1/agents/{agentId}/employees | Name (alphabetical) |
GET /v1/agents/{agentId}/knowledge-base | Created date (newest first) |
GET /v1/agents/{agentId}/calls | Created date (newest first) |
GET /v1/agents/{agentId}/forwarding-slots) and tools (GET /v1/agents/{agentId}/tools) return all records without pagination, as agents typically have a small number of these.
Tips
- Use
limit=100(the maximum) when you need to fetch large datasets to minimize the number of requests - Cache
pagination.totalto show progress indicators in your UI - Be aware that records may shift between pages if items are added or deleted during iteration