---
title: "Get an IVR by ID"
method: GET
path: "/ivrs/{ivrId}"
tags: ["ivrs"]
---

# Get an IVR by ID

`GET /ivrs/{ivrId}`

Retrieves detailed information about a specific IVR by its identifier, including its configuration, assigned numbers, scenarios, welcome message settings, business hours, and queue parameters. Use `GET /ivrs` to discover available IVR IDs.

**Permission:** `IVRs Read` required.

**Monitoring impact:**
- **OFF:** Returns the IVR only if it is **assigned to you**. Returns `404` otherwise.
- **ON:** Returns **any IVR** in the team.

## Path parameters

- `ivrId` integer, required

## Response `200`

Successful operation — returns the IVR details.

- Ivr
  - `ivr_id` integer — The identifier of the ivr
  - `name` string — The name of the ivr
  - `color` 'ff6b6b' | 'F06292' | 'BA68C8' | '9575CD' | '7986CB' | '64B5F6' | '4FC3F7' | '4DD0E1' | '4DB6AC' | '81C784' | 'AED581' | 'DCE775' | 'FFD54F' | 'FFB74D' | 'FF8A65' | 'A1887F' | 'E0E0E0' | '90A4AE'
  - `numbers` Number[] — The numbers of the ivr
    - `number` integer — Phone number in E.164 format without the `+` prefix (e.g., `33612345678`).
    - `label` string — The label of the number
    - `type` string — The type of the number
    - `user_id` integer — The user identifier
    - `ivr_id` integer — The unique identifier of the IVR. Use `GET /ivrs` to discover available IVR IDs.
    - `conference_id` integer — The conference identifier
    - `is_sms` boolean
    - `is_sms_write` boolean
    - `is_callable` boolean
    - `format` FormatNumber
      - `raw` integer
      - `country_code` string
      - `country` string
      - `e164` string
      - `international` string
      - `international_alt` string
      - `national` string
      - `national_alt` string
      - `rfc3966` string
      - `is_short_code` boolean
  - `scenarios` Scenario[]
    - `scenario_id` integer — The scenario identifier
    - `ivr_id` integer — The unique identifier of the IVR. Use `GET /ivrs` to discover available IVR IDs.
    - `name` string — The name of the scenario
    - `color` string
    - `scenario_type` 'menu' | 'announce' | 'queue' | 'sms' | 'webhook' | 'input' — The type of the scenario
    - `is_default` boolean
  - `is_open` boolean — The ivr is open or not

## Other responses

- `400` — Invalid IVR identifier.
- `401` — Unauthorized — invalid or missing API token, or missing `IVRs Read` permission.
- `404` — IVR not found, or not accessible with current monitoring level.
- `500` — Internal server error.

---

[API](https://skmtc.net/ringover/apis/ringover-public-api.md) · [All operations](https://skmtc.net/ringover/apis/ringover-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringover/ringover-public-api/revisions/9da73dd2f99e/schema)