Lists the calendars connected to your workspace that you can see, whether or not a receptionist books on them. An admin sees every calendar in the workspace…
GET/v2/api/calendars
Behavior
Lists the calendars connected to your workspace, whether or not a receptionist books on them. Each id is what the scheduling.calendars map on Update configuration is keyed by.
The list is not paginated: it is bounded by your team, not by usage.
What you can see
Visibility follows the same rule as the Allo app. An admin sees every calendar in the workspace, a team member only the ones they connected themselves. owner.is_current_user tells you which is which.
Connecting a calendar is an OAuth flow, done in the Allo app. This endpoint lists what is already connected.
Event types
Event types are not in this response, because reading them costs one round trip to the provider per calendar. Fetch them one calendar at a time with Get a calendar.
Errors
403 API_KEY_INSUFFICIENT_SCOPE: the key does not hold AGENTS_READ.
Authorization
Authorizationstring · headerrequired
Api-Key ak_live_…
Responses
200The calendars you can see
dataobject[]
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.