Skip to content
NorthplaneNorthplane

Get ivr-menu

GET
/api/v1/ivr-menus/{name}
curl --request GET \
  --url https://example.com/api/v1/ivr-menus/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
createdAt
required
string format: date-time
greeting
string
id
required
string
language
string
name
required
string
options
required
Array<object>
object
action
required
string
digit
required
string
escalationPolicy
string
label
string
labels
object
key
additional properties
string
record
boolean
severity
string
text
string
title
string
pin
string
tenantId
required
string
trustCallerId
boolean
updatedAt
required
string format: date-time
version
required
integer
voice
string
Examplegenerated
{
  "createdAt": "2026-04-15T12:00:00Z",
  "greeting": "example",
  "id": "example",
  "language": "example",
  "name": "example",
  "options": [
    {
      "action": "example",
      "digit": "example",
      "escalationPolicy": "example",
      "label": "example",
      "labels": {
        "additionalProperty": "example"
      },
      "record": true,
      "severity": "example",
      "text": "example",
      "title": "example"
    }
  ],
  "pin": "example",
  "tenantId": "example",
  "trustCallerId": true,
  "updatedAt": "2026-04-15T12:00:00Z",
  "version": 1,
  "voice": "example"
}

default

Section titled “default”

Problem Details (RFC 9457)

Media typeapplication/problem+json
object
code
required
string
detail
string
instance
string
status
required
integer
title
required
string
type
required
string
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}