Skip to navigation
Calendar

Get Calendar Connection

View as Markdown
Get one connected calendar account by provider and email address.

Authentication

AuthorizationToken

Format: Token <your_api_key>

Path parameters

providerenumRequired

google or outlook (microsoft is accepted as an alias for outlook).

Allowed values:
account_idstringRequired

The connected account's email address, URL-encoded.

Response

Success
connection_idstringOptional
account_idstringOptional
providerenumOptional
Allowed values:
emailstringOptional
display_namestringOptional
statusenumOptional
Allowed values:
statestringOptional

Lowercase form of status.

versionintegerOptional
created_atdatetimeOptional
updated_atdatetimeOptional
has_refresh_tokenbooleanOptional
calendars_countintegerOptional
metadatamap from strings to anyOptional
primary_calendar_idstringOptional
Google only.
watch_channels_countintegerOptional
Google only.
default_calendar_idstringOptional
Outlook only.
subscriptions_countintegerOptional
Outlook only.

Errors

400
Bad Request Error
404
Not Found Error