Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-173040119.6 KB
calendarList

Returns a calendar from the user's calendar list.

get/users/me/calendarList/{calendarId}

Path parameters

calendarIdstring required

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword

Response

A gcalendar:CalendarListEntry if successful, otherwise an error

summarystring

Title of the calendar. Read-only

backgroundColorstring

The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional

hiddenboolean

Whether the calendar has been hidden from the list. Optional. The attribute is only returned when the calendar is hidden, in which case the value is true

colorIdstring

The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional

kindstring

Type of the resource ("calendar#calendarListEntry")

descriptionstring

Description of the calendar. Optional. Read-only

timeZonestring

The time zone of the calendar. Optional. Read-only

foregroundColorstring

The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional

deletedboolean

Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False

summaryOverridestring

The summary that the authenticated user has set for this calendar. Optional

accessRolestring

The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:

  • "freeBusyReader" - Provides read access to free/busy information.
  • "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
  • "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
  • "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs
etagstring

ETag of the resource

locationstring

Geographic location of the calendar as free-form text. Optional. Read-only

idstring

Identifier of the calendar

selectedboolean

Whether the calendar content shows up in the calendar UI. Optional. The default is False

primaryboolean

Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False