Skip to main content
DialNexa list endpoints do not yet share a single response envelope. This page documents the exact shape each v1 list endpoint returns today, so you can parse responses without guessing. Each endpoint page also shows its full response schema in the panel on the right.

Request parameters

Most paginated endpoints accept page 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:
  1. Check the endpoint page before parsing. The records key differs per endpoint (data, items, voices, webhooks, agents, or the root array).
  2. For calls, which accept page and limit without returning pagination metadata, page forward until a request returns fewer records than limit.
  3. 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 a totalPages style field, iterate until you pass the last page. This example uses workflows:
For calls, which return a root array while accepting page and limit, stop when a page comes back with fewer records than limit:
  • Errors: the standard error format returned when a request fails.