Sign in

v1

latestOpenAPI 3.0.02026-07-249301.3 MB
Calendars

Retrieve a calendar

Retrieve the details of a calendar.

get/api/v1/calendars/{calendar_id}

Path parameters

calendar_idstring required

The id of the wanted calendar.

Query parameters

account_idstring required

The id of the account to use.

Response

OK

object'Calendar' required
idstring required

The ID of the calendar.

versionstring required

Opaque identifier representing the current state of the resource. The value changes whenever the resource is modified and should only be used for change detection.

namestring required

Name of the calendar.

descriptionstring

Description of the calendar.

is_read_onlyboolean required

Indicates if the calendar is read-only or not.

is_owned_by_userboolean required

Indicates if the user owns this calendar.

is_defaultboolean

Indicates if this is the default calendar of the user.

is_primaryboolean

Indicates if this is the primary calendar of the user.

access_role'owner' | 'writer' | 'reader' | 'freeBusyReader'

The access role of the authenticated user for this calendar.

etagstring

Provider ETag for this calendar.

background_colorstring required

Background color of the calendar in hexadecimal format.

foreground_colorstring

Foreground color of the calendar in hexadecimal format.

sync_activatedboolean

Indicates if calendar sync is activated.

timezonestring

Timezone used in this calendar.