Events

The Calendar API provides different flavors of event resources, more information can be found in About events.

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

Resource representations

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ]
}
Property name Value Description Notes
anyoneCanAddSelf boolean Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. writable
attachments[] list File attachments for the event. Currently only Google Drive attachments are supported.

In order to modify attachments the supportsAttachments request parameter should be set to true.

There can be at most 25 attachments per event,

attachments[].fileId string ID of the attached file. Read-only.

For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API.

attachments[].fileUrl string URL link to the attachment.

For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.

Required when adding an attachment.

writable
attachments[].mimeType string Internet media type (MIME type) of the attachment.
attachments[].title string Attachment title.
attendeesOmitted boolean Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. writable
attendees[] list The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. writable
attendees[].additionalGuests integer Number of additional guests. Optional. The default is 0. writable
attendees[].comment string The attendee's response comment. Optional. writable
attendees[].displayName string The attendee's name, if available. Optional. writable
attendees[].email string The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.

Required when adding an attendee.

writable
attendees[].id string The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
attendees[].optional boolean Whether this is an optional attendee. Optional. The default is False. writable
attendees[].organizer boolean Whether the attendee is the organizer of the event. Read-only. The default is False.
attendees[].resource boolean Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. writable
attendees[].responseStatus string The attendee's response status. Possible values are:
  • "needsAction" - The attendee has not responded to the invitation.
  • "declined" - The attendee has declined the invitation.
  • "tentative" - The attendee has tentatively accepted the invitation.
  • "accepted" - The attendee has accepted the invitation.
writable
attendees[].self boolean Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False.
colorId string The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. writable
conferenceData nested object The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. writable
conferenceData.conferenceId string The ID of the conference.

Can be used by developers to keep track of conferences, should not be displayed to users.

Values for solution types:

  • "eventHangout": unset.
  • "eventNamedHangout": the name of the Hangout.
  • "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc".
Optional.

conferenceData.conferenceSolution nested object The conference solution, such as Hangouts or Hangouts Meet.

Unset for a conference with a failed create request.

Either conferenceSolution and at least one entryPoint, or createRequest is required.

conferenceData.conferenceSolution.iconUri string The user-visible icon for this solution.
conferenceData.conferenceSolution.key nested object The key which can uniquely identify the conference solution for this event.
conferenceData.conferenceSolution.key.type string The conference solution type.

If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

The possible values are:

  • "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
  • "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
  • "hangoutsMeet" for Hangouts Meet (http://meet.google.com)

conferenceData.conferenceSolution.name string The user-visible name of this solution. Not localized.
conferenceData.createRequest nested object A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.

Either conferenceSolution and at least one entryPoint, or createRequest is required.

conferenceData.createRequest.conferenceSolutionKey nested object The conference solution, such as Hangouts or Hangouts Meet.
conferenceData.createRequest.conferenceSolutionKey.type string The conference solution type.

If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.

The possible values are:

  • "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
  • "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
  • "hangoutsMeet" for Hangouts Meet (http://meet.google.com)

conferenceData.createRequest.requestId string The client-generated unique ID for this request.

Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored.

conferenceData.createRequest.status nested object The status of the conference create request.
conferenceData.createRequest.status.statusCode string The current status of the conference create request. Read-only.

The possible values are:

  • "pending": the conference create request is still being processed.
  • "success": the conference create request succeeded, the entry points are populated.
  • "failure": the conference create request failed, there are no entry points.

conferenceData.entryPoints[] list Information about individual conference entry points, such as URLs or phone numbers.

All of them must belong to the same conference.

Either conferenceSolution and at least one entryPoint, or createRequest is required.

conferenceData.entryPoints[].accessCode string The access code to access the conference. The maximum length is 128 characters.

When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

Optional.

conferenceData.entryPoints[].entryPointType string The type of the conference entry point.

Possible values are:

  • "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
  • "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
  • "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
  • "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference.

conferenceData.entryPoints[].label string The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters.

Examples:

  • for video: meet.google.com/aaa-bbbb-ccc
  • for phone: +1 123 268 2601
  • for sip: 12345678@altostrat.com
  • for more: should not be filled

Optional.

conferenceData.entryPoints[].meetingCode string The meeting code to access the conference. The maximum length is 128 characters.

When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

Optional.

conferenceData.entryPoints[].passcode string The passcode to access the conference. The maximum length is 128 characters.

When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

conferenceData.entryPoints[].password string The password to access the conference. The maximum length is 128 characters.

When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

Optional.

conferenceData.entryPoints[].pin string The PIN to access the conference. The maximum length is 128 characters.

When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.

Optional.

conferenceData.entryPoints[].uri string The URI of the entry point. The maximum length is 1300 characters.

Format:

  • for video, http: or https: schema is required.
  • for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
  • for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
  • for more, http: or https: schema is required.

conferenceData.notes string Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional.
conferenceData.signature string The signature of the conference data.

Genereated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.

Unset for a conference with a failed create request.

Optional for a conference with a pending create request.

created datetime Creation time of the event (as a RFC3339 timestamp). Read-only.
creator object The creator of the event. Read-only.
creator.displayName string The creator's name, if available.
creator.email string The creator's email address, if available.
creator.id string The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
creator.self boolean Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
description string Description of the event. Optional. writable
end nested object The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
end.date date The date, in the format "yyyy-mm-dd", if this is an all-day event. writable
end.dateTime datetime The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. writable
end.timeZone string The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. writable
endTimeUnspecified boolean Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.
etag etag ETag of the resource.
extendedProperties object Extended properties of the event.
extendedProperties.private object Properties that are private to the copy of the event that appears on this calendar. writable
extendedProperties.private.(key) string The name of the private property and the corresponding value.
extendedProperties.shared object Properties that are shared between copies of the event on other attendees' calendars. writable
extendedProperties.shared.(key) string The name of the shared property and the corresponding value.
gadget object A gadget that extends this event.
gadget.display string The gadget's display mode. Optional. Possible values are:
  • "icon" - The gadget displays next to the event's title in the calendar view.
  • "chip" - The gadget displays when the event is clicked.
writable
gadget.height integer The gadget's height in pixels. The height must be an integer greater than 0. Optional. writable
gadget.preferences object Preferences. writable
gadget.preferences.(key) string The preference name and corresponding value.
gadget.title string The gadget's title. writable
gadget.type string The gadget's type. writable
gadget.width integer The gadget's width in pixels. The width must be an integer greater than 0. Optional. writable
guestsCanInviteOthers boolean Whether attendees other than the organizer can invite others to the event. Optional. The default is True. writable
guestsCanModify boolean Whether attendees other than the organizer can modify the event. Optional. The default is False. writable
guestsCanSeeOtherGuests boolean Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. writable
iCalUID string Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.

Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

id string Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
  • characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
  • the length of the ID must be between 5 and 1024 characters
  • the ID must be unique per calendar
Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.

If you do not specify an ID, it will be automatically generated by the server.

Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

writable
kind string Type of the resource ("calendar#event").
location string Geographic location of the event as free-form text. Optional. writable
locked boolean Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.
organizer object The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event. writable
organizer.displayName string The organizer's name, if available. writable
organizer.email string The organizer's email address, if available. It must be a valid email address as per RFC5322. writable
organizer.id string The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API
organizer.self boolean Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False.
originalStartTime nested object For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.
originalStartTime.date date The date, in the format "yyyy-mm-dd", if this is an all-day event. writable
originalStartTime.dateTime datetime The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. writable
originalStartTime.timeZone string The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. writable
privateCopy boolean Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.
recurrence[] list List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. writable
recurringEventId string For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
reminders object Information about the event's reminders for the authenticated user.
reminders.overrides[] list If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. writable
reminders.overrides[].method string The method used by this reminder. Possible values are:
  • "email" - Reminders are sent via email.
  • "sms" - Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
  • "popup" - Reminders are sent via a UI popup.

Required when adding a reminder.

writable
reminders.overrides[].minutes integer Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).

Required when adding a reminder.

writable
reminders.useDefault boolean Whether the default reminders of the calendar apply to the event. writable
sequence integer Sequence number as per iCalendar. writable
source object Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
source.title string Title of the source; for example a title of a web page or an email subject. writable
source.url string URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. writable
start nested object The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
start.date date The date, in the format "yyyy-mm-dd", if this is an all-day event. writable
start.dateTime datetime The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. writable
start.timeZone string The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. writable
status string Status of the event. Optional. Possible values are:
  • "confirmed" - The event is confirmed. This is the default status.
  • "tentative" - The event is tentatively confirmed.
  • "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them.

    A cancelled status represents two different states depending on the event type:

    1. Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event.

      Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.

    2. All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.

      Deleted events are only guaranteed to have the id field populated.

    On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.

    If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.

writable
summary string Title of the event. writable
transparency string Whether the event blocks time on the calendar. Optional. Possible values are:
  • "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
  • "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.
writable
updated datetime Last modification time of the event (as a RFC3339 timestamp). Read-only.
visibility string Visibility of the event. Optional. Possible values are:
  • "default" - Uses the default visibility for events on the calendar. This is the default value.
  • "public" - The event is public and event details are visible to all readers of the calendar.
  • "private" - The event is private and only event attendees may view event details.
  • "confidential" - The event is private. This value is provided for compatibility reasons.
writable

Methods

delete
Deletes an event.
get
Returns an event.
import
Imports an event. This operation is used to add a private copy of an existing event to a calendar.
insert
Creates an event.
instances
Returns instances of the specified recurring event.
list
Returns events on the specified calendar.
move
Moves an event to another calendar, i.e. changes an event's organizer.
patch
Updates an event. This method supports patch semantics. The field values you specify replace the existing values. Fields that you don’t specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements.
quickAdd
Creates an event based on a simple text string.
update
Updates an event.
watch
Watch for changes to Events resources.

Send feedback about...

Calendar API
Calendar API
Need help? Visit our support page.