API ReferenceTelephony

Get IVR Menu

Fetch one menu’s full shape. Returns 404 for missing, soft-deleted, or foreign-tenant menus — existence information is never leaked across tenants.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The IVR menu detail.
idstring

Prefixed wire identifier (menu_<26 char Crockford base32>). URL paths accept only this prefixed form; legacy UUID path parameters are rejected with 404.

fingerprint_idstring
schema_versioninteger
menu_treeobject

Validated menu_tree per contracts/agents/ivr_menu.schema.json. Opaque to consumers other than the worker.

confidence_scoredouble
succeeded_traversalsinteger
total_traversalsinteger
last_validated_atdatetime
created_atdatetime
updated_atdatetime
tenant_idstring or null

Null on the cross-tenant promoted slot.

invalidated_atdatetime or null

Errors

401
Unauthorized Error
404
Not Found Error