Skip to main content
GET
Get a connected calendar
Required scope: AGENTS_READ

Behavior

Returns one connected calendar with available_event_types, the event types its provider currently offers. This is the catalog you pick from when filling scheduling.calendars on Update configuration. The catalog is read live from the provider on every call, so it is always what the provider offers today.

Reading available_event_types

available_event_types is absent for a provider that has no event-type concept. That is a different answer from an empty list, which means the provider offers none. Two fields are worth knowing apart:
  • provider_description is the blurb written in the calendar provider. It is context, not routing.
  • description, which you send back in scheduling.calendars, is your own note on when the receptionist should book this event type rather than another. That is the text it matches a caller’s reason against.
required_questions are answers the provider rejects a booking without, so the receptionist collects them during the call. They are read-only, and snapshotted when you select the event type.

Errors

  • 404 AGENT_CALENDAR_NOT_FOUND: no calendar with that id is visible to you.
  • 500 AGENT_CALENDAR_EVENT_TYPES_FETCH_FAILED: the provider could not be reached. This one is retryable. If it keeps failing, the calendar connection has to be renewed in the Allo app.

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

Calendar identifier from GET /v2/api/calendars

Example:

"exc-abc123"

Response

The calendar and its available event types

data
object

A calendar connected to your workspace, whether or not a receptionist books on it.