Google Calendar API

API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. Acl
  2. CalendarList
  3. Calendars
  4. Colors
  5. Events
  6. Freebusy
  7. Settings
  8. Channels

Acl

For Acl Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/calendar/v3, unless otherwise noted
delete DELETE  /calendars/calendarId/acl/ruleId Deletes an access control rule.
get GET  /calendars/calendarId/acl/ruleId Returns an access control rule.
insert POST  /calendars/calendarId/acl Creates an access control rule.
list GET  /calendars/calendarId/acl Returns the rules in the access control list for the calendar.
patch PATCH  /calendars/calendarId/acl/ruleId Updates an access control rule. This method supports patch semantics.
update PUT  /calendars/calendarId/acl/ruleId Updates an access control rule.

CalendarList

For CalendarList Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/calendar/v3, unless otherwise noted
delete DELETE  /users/me/calendarList/calendarId Deletes an entry on the user's calendar list.
get GET  /users/me/calendarList/calendarId Returns an entry on the user's calendar list.
insert POST  /users/me/calendarList Adds an entry to the user's calendar list.
list GET  /users/me/calendarList Returns entries on the user's calendar list.
patch PATCH  /users/me/calendarList/calendarId Updates an entry on the user's calendar list. This method supports patch semantics.
update PUT  /users/me/calendarList/calendarId Updates an entry on the user's calendar list.

Calendars

For Calendars Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/calendar/v3, unless otherwise noted
clear POST  /calendars/calendarId/clear Clears a primary calendar. This operation deletes all data associated with the primary calendar of an account and cannot be undone.
delete DELETE  /calendars/calendarId Deletes a secondary calendar.
get GET  /calendars/calendarId Returns metadata for a calendar.
insert POST  /calendars Creates a secondary calendar.
patch PATCH  /calendars/calendarId Updates metadata for a calendar. This method supports patch semantics.
update PUT  /calendars/calendarId Updates metadata for a calendar.

Colors

For Colors Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/calendar/v3, unless otherwise noted
get GET  /colors Returns the color definitions for calendars and events.

Events

For Events Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/calendar/v3, unless otherwise noted
delete DELETE  /calendars/calendarId/events/eventId Deletes an event.
get GET  /calendars/calendarId/events/eventId Returns an event.
import POST  /calendars/calendarId/events/import Imports an event. This operation is used to add a private copy of an existing event to a calendar.
insert POST  /calendars/calendarId/events Creates an event.
instances GET  /calendars/calendarId/events/eventId/instances Returns instances of the specified recurring event.
list GET  /calendars/calendarId/events Returns events on the specified calendar.
move POST  /calendars/calendarId/events/eventId/move Moves an event to another calendar, i.e. changes an event's organizer.

Required query parameters: destination

patch PATCH  /calendars/calendarId/events/eventId Updates an event. This method supports patch semantics.
quickAdd POST  /calendars/calendarId/events/quickAdd Creates an event based on a simple text string.

Required query parameters: text

update PUT  /calendars/calendarId/events/eventId Updates an event.
watch POST  /calendars/calendarId/events/watch Watch for changes to Events resources.

Freebusy

For Freebusy Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/calendar/v3, unless otherwise noted
query POST  /freeBusy Returns free/busy information for a set of calendars.

Settings

For Settings Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/calendar/v3, unless otherwise noted
get GET  /users/me/settings/setting Returns a single user setting.
list GET  /users/me/settings Returns all user settings for the authenticated user.

Channels

For Channels Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/calendar/v3, unless otherwise noted
stop POST  /channels/stop Stop watching resources through this channel.

Authentication required

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

Signing you in...

Google Developers needs your permission to do that.