Google Calendar API

CalendarList

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean
}
Property name Value Description Notes
accessRole string 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.
backgroundColor string The main color of the calendar in the format '#0088aa'. This property supersedes the index-based colorId property. Optional. writable
colorId string 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). Optional. writable
defaultReminders[] list The default reminders that the authenticated user has for this calendar. writable
defaultReminders[].method string The method used by this reminder. Possible values are:
  • "email" - Reminders are sent via email.
  • "sms" - Reminders are sent via SMS.
  • "popup" - Reminders are sent via a UI popup.
defaultReminders[].minutes integer Number of minutes before the start of the event when the reminder should trigger.
description string Description of the calendar. Optional. Read-only.
etag etag ETag of the resource.
foregroundColor string The foreground color of the calendar in the format '#ffffff'. This property supersedes the index-based colorId property. Optional. writable
hidden boolean Whether the calendar has been hidden from the list. Optional. The default is False. writable
id string Identifier of the calendar.
kind string Type of the resource ("calendar#calendarListEntry").
location string Geographic location of the calendar as free-form text. Optional. Read-only.
notificationSettings object The notifications that the authenticated user is receiving for this calendar. writable
notificationSettings.notifications[] list The list of notifications set for this calendar.
notificationSettings.notifications[].method string The method used to deliver the notification. Possible values are:
  • "email" - Reminders are sent via email.
  • "sms" - Reminders are sent via SMS. This value is read-only and is ignored on inserts and updates.
notificationSettings.notifications[].type string The type of notification. Possible values are:
  • "eventCreation" - Notification sent when a new event is put on the calendar.
  • "eventChange" - Notification sent when an event is changed.
  • "eventCancellation" - Notification sent when an event is cancelled.
  • "eventResponse" - Notification sent when an event is changed.
  • "agenda" - An agenda with the events of the day (sent out in the morning).
primary boolean Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.
selected boolean Whether the calendar content shows up in the calendar UI. Optional. The default is False. writable
summary string Title of the calendar. Read-only.
summaryOverride string The summary that the authenticated user has set for this calendar. Optional. writable
timeZone string The time zone of the calendar. Optional. Read-only.

Methods

delete
Deletes an entry on the user's calendar list.
get
Returns an entry on the user's calendar list.
insert
Adds an entry to the user's calendar list.
list
Returns entries on the user's calendar list.
patch
Updates an entry on the user's calendar list. This method supports patch semantics.
update
Updates an entry on the user's calendar list.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.