Skip to main content
GET
Get call flow
Required scope: PHONE_NUMBERS_READ

Behavior

Returns the call flow for a phone number. The {number} path parameter is the Allo phone number in E.164 format (e.g. +14155551234). By default this returns the published flow. If the number has no published flow, Allo returns an in-memory synthesis of the legacy IVR configuration with status: "SYNTHESIZED" (nothing is persisted). Pass ?status=draft to fetch the working draft instead.
?status=draft falls back to the published flow (or the synthesis) when no draft exists. To read a draft without that fallback — getting a 404 instead — use Get call flow draft.

Fields

  • statusDRAFT, PUBLISHED, or SYNTHESIZED.
  • lock_version — optimistic-concurrency token. Pass it back when saving a draft.
  • number — E.164 of the line this flow routes (null for a SYNTHESIZED flow).
  • confirmation_url — present only on a DRAFT: the link where a signed-in user reviews and publishes it. See Save call flow draft.
  • definition — the opaque call flow tree document (camelCase keys), rooted at entry_node_id.

Errors

  • 404 PHONE_NUMBER_NOT_FOUND — the number is not one of your account’s numbers. List them with GET /v2/api/numbers.

Authorizations

Authorization
string
header
required

Path Parameters

number
string
required

Allo phone number in E.164 format

Example:

"+14155551234"

Query Parameters

status
enum<string>

Pass draft to fetch the working draft instead of the published flow.

Available options:
draft,
published

Response

The call flow

data
object

A version of a phone number's call flow.