Request parameters
Most paginated endpoints acceptpage and limit, but defaults and maximums are not fully standardized. Use the endpoint contract as the source of truth.
Example request
Response envelopes by endpoint
Three practical rules follow from the table:
- Check the endpoint page before parsing. The records key differs per endpoint (
data,items,voices,webhooks,agents, or the root array). - For calls, which accept
pageandlimitwithout returning pagination metadata, page forward until a request returns fewer records thanlimit. - Catalog endpoints (languages, LLMs, transcribers) return the full list. Fetch them once at startup or deploy time instead of paging.
Example: the workflows envelope
GET /v1/workflows wraps records in data and reports pagination in meta:
Iterating through all pages
For endpoints with atotalPages style field, iterate until you pass the last page. This example uses workflows:
page and limit, stop when a page comes back with fewer records than limit:
Related pages
- Errors: the standard error format returned when a request fails.