API ReferenceTelephonyIVR menus

List IVR Menus

Beta
List the active IVR menus the caller's workspace has learned. One row per (fingerprint, tenant). Invalidated rows and the cross-tenant shared slot are excluded. Sorted by `last_observed_at` DESC so the freshest IVRs land at the top. Cursor-paginated: omit `cursor` to fetch the first page. Default page size is 50 and max is 200. Walk pages while `has_more` is true.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Headers

Speechify-VersionstringOptional

Query parameters

fingerprintstringOptional

Optional SHA-256 fingerprint hash to narrow the list to one menu.

cursorstringOptional
Opaque pagination cursor from a previous response.
limitintegerOptional1-200Defaults to 50

Max items per page (default 50, max 200).

Response headers

X-Request-IDstring
Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

A list of cached IVR menus.
next_cursorstring or null

Opaque keyset cursor for the next page. Pass back as the cursor request parameter. null when the caller has reached the end of the list (has_more is also false in that case).

has_moreboolean
True when more rows exist beyond this page.
menuslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error