---
title: "Get the call plan of a number"
method: GET
path: "/numbers/{id}/call-plan"
tags: ["Call plans"]
---

# Get the call plan of a number

`GET /numbers/{id}/call-plan`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/numbers/{id}/call-plan`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `numbers:read`)

The call plan of one number, with its version. The version is also in the ETag header; send it back as If-Match with PUT.

## Path parameters

- `id` string, uuid, required

## Response `200`

The call plan that calls to this number follow: its own plan (source number) or, without one, the plan of the project (source project, version 0).

- CallPlanResponse
  - `number_id` string, uuid, required
  - `version` integer, required: The version of the number's own plan; 0 when the number has no own plan yet. Also in the ETag header.
  - `source` 'number' | 'project' | 'none', required: Where plan comes from. number: the number has its own plan. project: the number has no own plan and follows the plan of the project (set_assistant sets that one up); this is what callers get. none: no plan at all.
  - `plan` CallPlan, required: A call plan: a small graph. entry is the first node; every node points to the next by id. At most 50 nodes, and every node must be reachable from entry. Field names inside the plan are camelCase: the plan is stored exactly as you send it.
    - `entry` string, required: The id of the first node.
    - `nodes` object, required: The nodes by id. The key must be the same as the node's id.

## Other responses

- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `404`: Not Found: not_found.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)