Allo

Get a calendar

Returns one connected calendar with the event types its provider currently offers, read live from the provider. This is the catalog you pick from when…

GET/v2/api/calendars/{id}

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.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

idstringrequired

Calendar identifier from GET /v2/api/calendars

Responses

200The calendar and its available event types
dataobject

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

7 fields
idstring

What scheduling.calendars on PATCH /v2/api/numbers/{number}/agent is keyed by.

namestring | null
providerenum<string>

GOOGLE_CALENDARCAL_COMCALENDLYOUTLOOK

statusenum<string>

ACTIVEDISCONNECTED

is_team_defaultboolean
ownerobject

The teammate who connected the calendar.

4 fields
user_idstring
user_namestring | null
emailstring | null
is_current_userboolean
available_event_typesobject[]

Reported by GET /v2/api/calendars/{id} only, read live from the provider. Absent for a provider with no event-type concept, which is not the same answer as an empty list.

6 fields
idstring
slugstring | null
titlestring
length_in_minutesinteger | null
provider_descriptionstring | null

The blurb written in the calendar provider. Not the routing note the receptionist matches on: that one is the description you send in scheduling.calendars.

required_questionsobject[]
2 fields
idstring
labelstring
401
403
404
429