Skip to main content
GET
Get AI receptionist configuration
Required scope: AGENTS_READ

Behavior

Returns the whole configuration of one line’s AI receptionist. The {number} path parameter is the Allo phone number in E.164 format. Read this before any write. Update configuration replaces whole collections, so you need the current state to avoid dropping configuration you did not mean to touch.

What comes back

  • agent holds the receptionist’s own settings, plus status and is_default, which are read-only here.
  • prompt carries either sections or custom_prompt, never both. custom_prompt is what an older line has when its prompt was written as freeform text.
  • capabilities always reports all three toggles, so false means off, not unavailable.
  • scheduling.calendars lists only the calendars this receptionist books on. To see every calendar connected to the workspace, call List calendars.
  • knowledge.websites reports each entry without its scraped text. That text is what the receptionist reads, not something you configure.

Errors

  • 403 API_KEY_INSUFFICIENT_SCOPE: the key does not hold AGENTS_READ.
  • 404 PHONE_NUMBER_NOT_FOUND: the number is not one you have access to.

Authorizations

Authorization
string
header
required

Path Parameters

number
string
required

Allo phone number in E.164 format

Example:

"+14155551234"

Response

The line's receptionist configuration

data
object

The whole configuration of one line's AI receptionist.