---
title: "List menu options"
method: GET
path: "/v2/api/numbers/{number}/menu_options"
tags: ["Inboxes"]
---

# List menu options

`GET /v2/api/numbers/{number}/menu_options`

## Request

- Base URL: `https://api.withallo.com`
- URL: `https://api.withallo.com/v2/api/numbers/{number}/menu_options`
- Auth: API key in header `Authorization`

Flattens the phone-menu tree of the line's published call flow. Each option carries a ready `MENU_BRANCH` condition. A line without a phone menu, or whose calls are not routed by the call-flow engine, returns an empty list. Menu conditions are only accepted on lines where this list is not empty.

## Path parameters

- `number` string, required

## Response `200`

Menu options

- object
  - `data` MenuOption[]
    - `node_id` string, required: The menu node of the last step.
    - `path` InboxMenuBranchStep[], required: Menu choices from the first menu down to this option.
      - `node_id` string, required: ID of the phone-menu node in the line's published call flow.
      - `digit` string, required: Key pressed at that menu.
    - `digits` string, required: The same path as keys, separated by `>`.
    - `label` string, required
    - `condition` union, required: Narrows a source to calls that went through part of the line's phone menu. A source holds at most 10 conditions, and an inbox at most 60 menu steps in all.
      - InboxMenuOptionCondition: Matches keys of one phone menu.
        - `type` 'MENU_OPTION', required
        - `node_id` string, required: The menu node.
        - `digits` string[], required: Keys that match, distinct. May be `[]` only when `include_no_choice` is `true`, to match calls that reached the menu without pressing a key.
        - `include_no_choice` boolean, required: Also match calls that reached the menu without pressing a key.
      - InboxMenuBranchCondition: Matches any of several paths through the line's phone menus. To combine several options of one line, put all their paths in `branches`.
        - `type` 'MENU_BRANCH', required
        - `branches` array[], required: Each branch lists the menu choices from the first menu down to the option picked.
          - InboxMenuBranchStep[]
            - `node_id` string, required: ID of the phone-menu node in the line's published call flow.
            - `digit` string, required: Key pressed at that menu.
        - `include_no_choice` boolean, required: Also match calls that reached the menu without pressing a key.

## Other responses

- `401`: Invalid or missing API key
- `403`: API key lacks the required scope or access to the resource
- `429`: Rate limit exceeded

## Changes

- **2026-11-03** `46c77103dd14`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/withallo/apis/allo-api/changes/v2/api/numbers/:number/menu_options/get.md)

---

[API](https://skmtc.dev/withallo/apis/allo-api.md) - [All operations](https://skmtc.dev/withallo/apis/allo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/withallo/apis/allo-api/revisions/46c77103dd14?raw)