---
title: "Get inbox suggestions"
method: GET
path: "/v2/api/inboxes/suggestions"
tags: ["Inboxes"]
---

# Get inbox suggestions

`GET /v2/api/inboxes/suggestions`

## Request

- Base URL: `https://api.withallo.com`
- URL: `https://api.withallo.com/v2/api/inboxes/suggestions`
- Auth: API key in header `Authorization`

Ready-made inbox sources ranked from the caller's recent calls and texts, including phone-menu branches. Each suggestion carries a `source` to put in `sources` as is. Suggestions are for the caller only.

## Response `200`

Suggestions, best first

- object
  - `data` InboxSuggestion[]
    - `allo_number` string, required
    - `name` string, nullable, required: Suggested inbox name. Always `null` for a whole-line suggestion (`branch: null`).
    - `description` string, nullable, required: Always `null` for a whole-line suggestion (`branch: null`).
    - `branch` InboxMenuBranchStep[], nullable, required: Phone-menu path, or null for the whole line.
      - `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.
    - `answered` integer, required: Calls the caller answered from this source recently.
    - `rung` integer, required: Calls that rang the caller from this source recently.
    - `texted` integer, required: Texts the caller exchanged on this source recently.
    - `score` integer, required: Ranking score. Higher first.
    - `source` InboxSource, required
      - `allo_number` string, required: Allo line (E.164).
      - `conditions` InboxCondition[], required: Empty means every conversation on the line.
        - union: 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.
              - …
            - `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/inboxes/suggestions/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)