Google: Calendar events schemas

← Calendar events operations · All schemas

Creates an event — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
anyoneCanAddSelf	boolean	Optional	Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. Default: false
attachments	array	Optional	File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,
attachments[]	Model	Each item	Expand Creates an event — response body — attachments item
attendees	array	Optional	The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.
attendees[]	Model	Each item	Expand Creates an event — request body — body attendees item
attendeesOmitted	boolean	Optional	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. Default: false
birthdayProperties	Model	Optional	Expand Creates an event — response body — birthday Properties Birthday or special event data. Used if eventType is "birthday". Immutable.
colorId	string	Optional	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.
conferenceData	Model	Optional	Expand Creates an event — response body — conference Data The conference-related information, such as details of a Google 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. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
created	string	Optional	Creation time of the event (as a RFC3339 timestamp). Read-only. Format: date-time
creator	Model	Optional	Expand Creates an event — response body — creator
description	string	Optional	Description of the event. Can contain HTML. Optional.
end	Model	Required within parent	Expand Creates an event — response body — end The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
endTimeUnspecified	boolean	Optional	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. Default: false
etag	string	Optional	ETag of the resource.
eventLabelId	string	Optional	The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. Setting an empty string, or not setting this field at all, will remove the existing label from the event.
eventType	string	Optional	Specific type of the event. This cannot be modified after the event is created. Possible values are: - "birthday" - A special all-day event with an annual recurrence. - "default" - A regular event or not further specified. - "focusTime" - A focus-time event. - "fromGmail" - An event from Gmail. This type of event cannot be created. - "outOfOffice" - An out-of-office event. - "workingLocation" - A working location event. Default: default
extendedProperties	Model	Optional	Expand Creates an event — response body — extended Properties
focusTimeProperties	Model	Optional	Expand Creates an event — response body — focus Time Properties Focus Time event data. Used if eventType is focusTime.
gadget	Model	Optional	Expand Creates an event — request body — body gadget
guestsCanInviteOthers	boolean	Optional	Whether attendees other than the organizer can invite others to the event. Optional. The default is True. Default: true
guestsCanModify	boolean	Optional	Whether attendees other than the organizer can modify the event. Optional. The default is False. Default: false
guestsCanSeeOtherGuests	boolean	Optional	Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. Default: true
hangoutLink	string	Optional	An absolute link to the Google Hangout associated with this event. Read-only.
htmlLink	string	Optional	An absolute link to this event in the Google Calendar Web UI. Read-only.
iCalUID	string	Optional	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. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.
id	string	Optional	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.
kind	string	Optional	Type of the resource ("calendar#event"). Default: calendar#event
location	string	Optional	Geographic location of the event as free-form text. Optional.
locked	boolean	Optional	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. Default: false
organizer	Model	Optional	Expand Creates an event — response body — organizer
originalStartTime	Model	Optional	Expand Creates an event — response body — end 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.
outOfOfficeProperties	Model	Optional	Expand Creates an event — response body — out Of Office Properties Out of office event data. Used if eventType is outOfOffice.
privateCopy	boolean	Optional	If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. Default: false
recurrence	array	Optional	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.
recurrence[]	string	Each item
recurringEventId	string	Optional	For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
reminders	Model	Optional	Expand Creates an event — request body — body reminders
sequence	integer	Optional	Sequence number as per iCalendar. Format: int32
source	object	Optional	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	Optional	Title of the source; for example a title of a web page or an email subject.
source.url	string	Optional	URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
start	Model	Required within parent	Expand Creates an event — response body — end The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
status	string	Optional	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: - 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. - 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.
summary	string	Optional	Title of the event.
transparency	string	Optional	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. Default: opaque
updated	string	Optional	Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. Format: date-time
visibility	string	Optional	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. Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. Default: default
workingLocationProperties	Model	Optional	Expand Creates an event — response body — working Location Properties Working location event data.

Referenced models: Creates an event — response body — conference Data, Creates an event — response body — attachments item, Creates an event — response body — birthday Properties, Creates an event — response body — end, Creates an event — response body — focus Time Properties, Creates an event — response body — out Of Office Properties, Creates an event — response body — working Location Properties, Creates an event — request body — body attendees item, Creates an event — response body — creator, Creates an event — response body — extended Properties, Creates an event — request body — body gadget, Creates an event — response body — organizer, Creates an event — request body — body reminders

Creates an event — request body — body attendees item

Field	Type	Presence	Description and constraints
$	object	Root
additionalGuests	integer	Optional	Number of additional guests. Optional. The default is 0. Default: 0 Format: int32
asyncOperation	string	Optional	If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. Possible values are: - "inProgress" - The asynchronous operation is in progress. - (not present) - Otherwise. Default:
comment	string	Optional	The attendee's response comment. Optional.
displayName	string	Optional	The attendee's name, if available. Optional.
email	string	Optional	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.
id	string	Optional	The attendee's Profile ID, if available.
optional	boolean	Optional	Whether this is an optional attendee. Optional. The default is False. Default: false
organizer	boolean	Optional	Whether the attendee is the organizer of the event. Read-only. The default is False.
resource	boolean	Optional	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. Default: false
responseStatus	string	Optional	The attendee's response status. Possible values are: - "needsAction" - The attendee has not responded to the invitation (recommended for new events). - "declined" - The attendee has declined the invitation. - "tentative" - The attendee has tentatively accepted the invitation. - "accepted" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the "Add invitations to my calendar" setting set to "When I respond to invitation in email" or "Only if the sender is known" might have their response reset to needsAction and won't see an event in their calendar unless they change their response in the event invitation email. Furthermore, if more than 200 guests are invited to the event, response status is not propagated to the guests.
self	boolean	Optional	Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. Default: false

Creates an event — request body — body gadget

Field	Type	Presence	Description and constraints
$	object	Root	A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.
display	string	Optional	The gadget's display mode. Deprecated. 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.
height	integer	Optional	The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. Format: int32
iconLink	string	Optional	The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.
link	string	Optional	The gadget's URL. The URL scheme must be HTTPS. Deprecated.
preferences	object	Optional	Preferences. Additional keys: see wildcard field
preferences.*	string	Additional keys	The preference name and corresponding value.
title	string	Optional	The gadget's title. Deprecated.
type	string	Optional	The gadget's type. Deprecated.
width	integer	Optional	The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. Format: int32

Creates an event — request body — body reminders

Field	Type	Presence	Description and constraints
$	object	Root	Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.
overrides	array	Optional	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.
overrides[]	Model	Each item	Expand Updates an existing calendar on the user's calendar list — request body — body default Reminders item
useDefault	boolean	Optional	Whether the default reminders of the calendar apply to the event.

Referenced models: Updates an existing calendar on the user's calendar list — request body — body default Reminders item

Creates an event — response body

Field	Type	Presence	Description and constraints
$	object	Root
anyoneCanAddSelf	boolean	Optional	Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. Default: false
attachments	array	Optional	File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,
attachments[]	Model	Each item	Expand Creates an event — response body — attachments item
attendees	array	Optional	The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.
attendees[]	Model	Each item	Expand Creates an event — response body — attendees item
attendeesOmitted	boolean	Optional	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. Default: false
birthdayProperties	Model	Optional	Expand Creates an event — response body — birthday Properties Birthday or special event data. Used if eventType is "birthday". Immutable.
colorId	string	Optional	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.
conferenceData	Model	Optional	Expand Creates an event — response body — conference Data The conference-related information, such as details of a Google 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. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
created	string	Optional	Creation time of the event (as a RFC3339 timestamp). Read-only. Format: date-time
creator	Model	Optional	Expand Creates an event — response body — creator
description	string	Optional	Description of the event. Can contain HTML. Optional.
end	Model	Optional	Expand Creates an event — response body — end The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
endTimeUnspecified	boolean	Optional	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. Default: false
etag	string	Optional	ETag of the resource.
eventLabelId	string	Optional	The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. Setting an empty string, or not setting this field at all, will remove the existing label from the event.
eventType	string	Optional	Specific type of the event. This cannot be modified after the event is created. Possible values are: - "birthday" - A special all-day event with an annual recurrence. - "default" - A regular event or not further specified. - "focusTime" - A focus-time event. - "fromGmail" - An event from Gmail. This type of event cannot be created. - "outOfOffice" - An out-of-office event. - "workingLocation" - A working location event. Default: default
extendedProperties	Model	Optional	Expand Creates an event — response body — extended Properties
focusTimeProperties	Model	Optional	Expand Creates an event — response body — focus Time Properties Focus Time event data. Used if eventType is focusTime.
gadget	object	Optional	A gadget that extends this event. Gadgets are deprecated; this structure is instead only used for returning birthday calendar metadata.
gadget.display	string	Optional	The gadget's display mode. Deprecated. 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.
gadget.height	JSON	Optional
gadget.height (anyOf 1)	integer	Alternative	The gadget's height in pixels. The height must be an integer greater than 0. Optional. Deprecated. Format: int32
gadget.height (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gadget.iconLink	string	Optional	The gadget's icon URL. The URL scheme must be HTTPS. Deprecated.
gadget.link	string	Optional	The gadget's URL. The URL scheme must be HTTPS. Deprecated.
gadget.preferences	object	Optional	Preferences. Additional keys: see wildcard field
gadget.preferences.*	string	Additional keys	The preference name and corresponding value.
gadget.title	string	Optional	The gadget's title. Deprecated.
gadget.type	string	Optional	The gadget's type. Deprecated.
gadget.width	JSON	Optional
gadget.width (anyOf 1)	integer	Alternative	The gadget's width in pixels. The width must be an integer greater than 0. Optional. Deprecated. Format: int32
gadget.width (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
guestsCanInviteOthers	boolean	Optional	Whether attendees other than the organizer can invite others to the event. Optional. The default is True. Default: true
guestsCanModify	boolean	Optional	Whether attendees other than the organizer can modify the event. Optional. The default is False. Default: false
guestsCanSeeOtherGuests	boolean	Optional	Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. Default: true
hangoutLink	string	Optional	An absolute link to the Google Hangout associated with this event. Read-only.
htmlLink	string	Optional	An absolute link to this event in the Google Calendar Web UI. Read-only.
iCalUID	string	Optional	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. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.
id	string	Optional	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.
kind	string	Optional	Type of the resource ("calendar#event"). Default: calendar#event
location	string	Optional	Geographic location of the event as free-form text. Optional.
locked	boolean	Optional	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. Default: false
organizer	Model	Optional	Expand Creates an event — response body — organizer
originalStartTime	Model	Optional	Expand Creates an event — response body — end 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.
outOfOfficeProperties	Model	Optional	Expand Creates an event — response body — out Of Office Properties Out of office event data. Used if eventType is outOfOffice.
privateCopy	boolean	Optional	If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. Default: false
recurrence	array	Optional	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.
recurrence[]	string	Each item
recurringEventId	string	Optional	For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
reminders	object	Optional	Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.
reminders.overrides	array	Optional	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.
reminders.overrides[]	Model	Each item	Expand Returns events on the specified calendar — response body — default Reminders item
reminders.useDefault	boolean	Optional	Whether the default reminders of the calendar apply to the event.
sequence	JSON	Optional
sequence (anyOf 1)	integer	Alternative	Sequence number as per iCalendar. Format: int32
sequence (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
source	object	Optional	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	Optional	Title of the source; for example a title of a web page or an email subject.
source.url	string	Optional	URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
start	Model	Optional	Expand Creates an event — response body — end The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
status	string	Optional	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: - 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. - 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.
summary	string	Optional	Title of the event.
transparency	string	Optional	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. Default: opaque
updated	string	Optional	Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. Format: date-time
visibility	string	Optional	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. Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. Default: default
workingLocationProperties	Model	Optional	Expand Creates an event — response body — working Location Properties Working location event data.

Referenced models: Creates an event — response body — conference Data, Creates an event — response body — attachments item, Creates an event — response body — attendees item, Creates an event — response body — birthday Properties, Creates an event — response body — end, Creates an event — response body — focus Time Properties, Creates an event — response body — out Of Office Properties, Returns events on the specified calendar — response body — default Reminders item, Creates an event — response body — working Location Properties, Creates an event — response body — creator, Creates an event — response body — extended Properties, Creates an event — response body — organizer

Creates an event — response body — attachments item

Field	Type	Presence	Description and constraints
$	object	Root
fileId	string	Optional	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.
fileUrl	string	Optional	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.
iconLink	string	Optional	URL link to the attachment's icon. This field can only be modified for custom third-party attachments.
mimeType	string	Optional	Internet media type (MIME type) of the attachment.
title	string	Optional	Attachment title.

Creates an event — response body — attendees item

Field	Type	Presence	Description and constraints
$	object	Root
additionalGuests	JSON	Optional
additionalGuests (anyOf 1)	integer	Alternative	Number of additional guests. Optional. The default is 0. Default: 0 Format: int32
additionalGuests (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
asyncOperation	string	Optional	If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. Possible values are: - "inProgress" - The asynchronous operation is in progress. - (not present) - Otherwise. Default:
comment	string	Optional	The attendee's response comment. Optional.
displayName	string	Optional	The attendee's name, if available. Optional.
email	string	Optional	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.
id	string	Optional	The attendee's Profile ID, if available.
optional	boolean	Optional	Whether this is an optional attendee. Optional. The default is False. Default: false
organizer	boolean	Optional	Whether the attendee is the organizer of the event. Read-only. The default is False.
resource	boolean	Optional	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. Default: false
responseStatus	string	Optional	The attendee's response status. Possible values are: - "needsAction" - The attendee has not responded to the invitation (recommended for new events). - "declined" - The attendee has declined the invitation. - "tentative" - The attendee has tentatively accepted the invitation. - "accepted" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the "Add invitations to my calendar" setting set to "When I respond to invitation in email" or "Only if the sender is known" might have their response reset to needsAction and won't see an event in their calendar unless they change their response in the event invitation email. Furthermore, if more than 200 guests are invited to the event, response status is not propagated to the guests.
self	boolean	Optional	Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. Default: false

Creates an event — response body — birthday Properties

Field	Type	Presence	Description and constraints
$	object	Root
contact	string	Optional	Resource name of the contact this birthday event is linked to. This can be used to fetch contact details from People API. Format: "people/c12345". Read-only.
customTypeName	string	Optional	Custom type label specified for this event. This is populated if birthdayProperties.type is set to "custom". Read-only.
type	string	Optional	Type of birthday or special event. Possible values are: - "anniversary" - An anniversary other than birthday. Always has a contact. - "birthday" - A birthday event. This is the default value. - "custom" - A special date whose label is further specified in the customTypeName field. Always has a contact. - "other" - A special date which does not fall into the other categories, and does not have a custom label. Always has a contact. - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created. Default: birthday

Creates an event — response body — conference Data

Field	Type	Presence	Description and constraints
$	object	Root
conferenceId	string	Optional	The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. The ID value is formed differently for each conference solution type: - eventHangout: ID is not set. (This conference type is deprecated.) - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.) - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc. - addOn: ID is defined by the third-party provider. Optional.
conferenceSolution	Model	Optional	Expand Creates an event — response body — conference Data conference Solution The conference solution, such as Google Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required.
createRequest	Model	Optional	Expand Creates an event — response body — conference Data create Request 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.
entryPoints	array	Optional	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.
entryPoints[]	Model	Each item	Expand Creates an event — response body — conference Data entry Points item
notes	string	Optional	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.
parameters	Model	Optional	Expand Creates an event — response body — conference Data parameters Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming.
signature	string	Optional	The signature of the conference data. Generated on server side. Unset for a conference with a failed create request. Optional for a conference with a pending create request.

Referenced models: Creates an event — response body — conference Data parameters, Creates an event — response body — conference Data conference Solution, Creates an event — response body — conference Data create Request, Creates an event — response body — conference Data entry Points item

Creates an event — response body — conference Data conference Solution

Field	Type	Presence	Description and constraints
$	object	Root
iconUri	string	Optional	The user-visible icon for this solution.
key	Model	Optional	Expand Creates an event — response body — conference Data conference Solution key The key which can uniquely identify the conference solution for this event.
name	string	Optional	The user-visible name of this solution. Not localized.

Referenced models: Creates an event — response body — conference Data conference Solution key

Creates an event — response body — conference Data conference Solution key

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Optional	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 (deprecated; existing events may show this conference solution type but new conferences cannot be created) - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created) - "hangoutsMeet" for Google Meet (http://meet.google.com) - "addOn" for 3P conference providers

Creates an event — response body — conference Data create Request

Field	Type	Presence	Description and constraints
$	object	Root
conferenceSolutionKey	Model	Optional	Expand Creates an event — response body — conference Data conference Solution key The conference solution, such as Hangouts or Google Meet.
requestId	string	Optional	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.
status	Model	Optional	Expand Creates an event — response body — conference Data create Request status The status of the conference create request.

Referenced models: Creates an event — response body — conference Data create Request status, Creates an event — response body — conference Data conference Solution key

Creates an event — response body — conference Data create Request status

Field	Type	Presence	Description and constraints
$	object	Root
statusCode	string	Optional	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.

Creates an event — response body — conference Data entry Points item

Field	Type	Presence	Description and constraints
$	object	Root
accessCode	string	Optional	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.
entryPointFeatures	array	Optional	Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point.
entryPointFeatures[]	string	Each item
entryPointType	string	Optional	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.
label	string	Optional	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@example.com - for more: should not be filled Optional.
meetingCode	string	Optional	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.
passcode	string	Optional	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.
password	string	Optional	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.
pin	string	Optional	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.
regionCode	string	Optional	The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. Calendar backend will populate this field only for EntryPointType.PHONE.
uri	string	Optional	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@example.com. - for more, http: or https: schema is required.

Creates an event — response body — conference Data parameters

Field	Type	Presence	Description and constraints
$	object	Root
addOnParameters	Model	Optional	Expand Creates an event — response body — conference Data parameters add On Parameters Additional add-on specific data.

Referenced models: Creates an event — response body — conference Data parameters add On Parameters

Creates an event — response body — conference Data parameters add On Parameters

Field	Type	Presence	Description and constraints
$	object	Root
parameters	object	Optional	Additional keys: see wildcard field
parameters.*	string	Additional keys

Creates an event — response body — creator

Field	Type	Presence	Description and constraints
$	object	Root	The creator of the event. Read-only.
displayName	string	Optional	The creator's name, if available.
email	string	Optional	The creator's email address, if available.
id	string	Optional	The creator's Profile ID, if available.
self	boolean	Optional	Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. Default: false

Creates an event — response body — end

Field	Type	Presence	Description and constraints
$	object	Root
date	string	Optional	The date, in the format "yyyy-mm-dd", if this is an all-day event. Format: date
dateTime	string	Optional	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. Format: date-time
timeZone	string	Optional	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.

Creates an event — response body — extended Properties

Field	Type	Presence	Description and constraints
$	object	Root	Extended properties of the event.
private	object	Optional	Properties that are private to the copy of the event that appears on this calendar. Additional keys: see wildcard field
private.*	string	Additional keys	The name of the private property and the corresponding value.
shared	object	Optional	Properties that are shared between copies of the event on other attendees' calendars. Additional keys: see wildcard field
shared.*	string	Additional keys	The name of the shared property and the corresponding value.

Creates an event — response body — focus Time Properties

Field	Type	Presence	Description and constraints
$	object	Root
autoDeclineMode	string	Optional	Whether to decline meeting invitations which overlap Focus Time events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Focus Time event is present are to be declined.
chatStatus	string	Optional	The status to mark the user in Chat and related products. This can be available or doNotDisturb.
declineMessage	string	Optional	Response message to set if an existing event or new invitation is automatically declined by Calendar.

Creates an event — response body — organizer

Field	Type	Presence	Description and constraints
$	object	Root	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.
displayName	string	Optional	The organizer's name, if available.
email	string	Optional	The organizer's email address, if available. It must be a valid email address as per RFC5322.
id	string	Optional	The organizer's Profile ID, if available.
self	boolean	Optional	Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False. Default: false

Creates an event — response body — out Of Office Properties

Field	Type	Presence	Description and constraints
$	object	Root
autoDeclineMode	string	Optional	Whether to decline meeting invitations which overlap Out of office events. Valid values are declineNone, meaning that no meeting invitations are declined; declineAllConflictingInvitations, meaning that all conflicting meeting invitations that conflict with the event are declined; and declineOnlyNewConflictingInvitations, meaning that only new conflicting meeting invitations which arrive while the Out of office event is present are to be declined.
declineMessage	string	Optional	Response message to set if an existing event or new invitation is automatically declined by Calendar.

Creates an event — response body — working Location Properties

Field	Type	Presence	Description and constraints
$	object	Root
customLocation	object	Optional	If present, specifies that the user is working from a custom location.
customLocation.label	string	Optional	An optional extra label for additional information.
homeOffice	JSON	Optional	If present, specifies that the user is working at home.
officeLocation	object	Optional	If present, specifies that the user is working from an office.
officeLocation.buildingId	string	Optional	An optional building identifier. This should reference a building ID in the organization's Resources database.
officeLocation.deskId	string	Optional	An optional desk identifier.
officeLocation.floorId	string	Optional	An optional floor identifier.
officeLocation.floorSectionId	string	Optional	An optional floor section identifier.
officeLocation.label	string	Optional	The office name that's displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization's Resources database.
type	string	Optional	Type of the working location. Possible values are: - "homeOffice" - The user is working at home. - "officeLocation" - The user is working from an office. - "customLocation" - The user is working from a custom location. Any details are specified in a sub-field of the specified name, but this field may be missing if empty. Any other fields are ignored. Required when adding working location properties.

Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported.
Deprecated behavior: If a non-default event is imported, its type will be changed to default and any event-type-specific properties it may have will be dropped — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
anyoneCanAddSelf	boolean	Optional	Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. Default: false
attachments	array	Optional	File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,
attachments[]	Model	Each item	Expand Creates an event — response body — attachments item
attendees	array	Optional	The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.
attendees[]	Model	Each item	Expand Creates an event — request body — body attendees item
attendeesOmitted	boolean	Optional	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. Default: false
birthdayProperties	Model	Optional	Expand Creates an event — response body — birthday Properties Birthday or special event data. Used if eventType is "birthday". Immutable.
colorId	string	Optional	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.
conferenceData	Model	Optional	Expand Creates an event — response body — conference Data The conference-related information, such as details of a Google 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. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
created	string	Optional	Creation time of the event (as a RFC3339 timestamp). Read-only. Format: date-time
creator	Model	Optional	Expand Creates an event — response body — creator
description	string	Optional	Description of the event. Can contain HTML. Optional.
end	Model	Required within parent	Expand Creates an event — response body — end The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
endTimeUnspecified	boolean	Optional	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. Default: false
etag	string	Optional	ETag of the resource.
eventLabelId	string	Optional	The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. Setting an empty string, or not setting this field at all, will remove the existing label from the event.
eventType	string	Optional	Specific type of the event. This cannot be modified after the event is created. Possible values are: - "birthday" - A special all-day event with an annual recurrence. - "default" - A regular event or not further specified. - "focusTime" - A focus-time event. - "fromGmail" - An event from Gmail. This type of event cannot be created. - "outOfOffice" - An out-of-office event. - "workingLocation" - A working location event. Default: default
extendedProperties	Model	Optional	Expand Creates an event — response body — extended Properties
focusTimeProperties	Model	Optional	Expand Creates an event — response body — focus Time Properties Focus Time event data. Used if eventType is focusTime.
gadget	Model	Optional	Expand Creates an event — request body — body gadget
guestsCanInviteOthers	boolean	Optional	Whether attendees other than the organizer can invite others to the event. Optional. The default is True. Default: true
guestsCanModify	boolean	Optional	Whether attendees other than the organizer can modify the event. Optional. The default is False. Default: false
guestsCanSeeOtherGuests	boolean	Optional	Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. Default: true
hangoutLink	string	Optional	An absolute link to the Google Hangout associated with this event. Read-only.
htmlLink	string	Optional	An absolute link to this event in the Google Calendar Web UI. Read-only.
iCalUID	string	Required within parent	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. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.
id	string	Optional	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.
kind	string	Optional	Type of the resource ("calendar#event"). Default: calendar#event
location	string	Optional	Geographic location of the event as free-form text. Optional.
locked	boolean	Optional	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. Default: false
organizer	Model	Optional	Expand Creates an event — response body — organizer
originalStartTime	Model	Optional	Expand Creates an event — response body — end 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.
outOfOfficeProperties	Model	Optional	Expand Creates an event — response body — out Of Office Properties Out of office event data. Used if eventType is outOfOffice.
privateCopy	boolean	Optional	If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. Default: false
recurrence	array	Optional	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.
recurrence[]	string	Each item
recurringEventId	string	Optional	For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
reminders	Model	Optional	Expand Creates an event — request body — body reminders
sequence	integer	Optional	Sequence number as per iCalendar. Format: int32
source	object	Optional	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	Optional	Title of the source; for example a title of a web page or an email subject.
source.url	string	Optional	URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
start	Model	Required within parent	Expand Creates an event — response body — end The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
status	string	Optional	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: - 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. - 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.
summary	string	Optional	Title of the event.
transparency	string	Optional	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. Default: opaque
updated	string	Optional	Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. Format: date-time
visibility	string	Optional	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. Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. Default: default
workingLocationProperties	Model	Optional	Expand Creates an event — response body — working Location Properties Working location event data.

Referenced models: Creates an event — response body — conference Data, Creates an event — response body — attachments item, Creates an event — response body — birthday Properties, Creates an event — response body — end, Creates an event — response body — focus Time Properties, Creates an event — response body — out Of Office Properties, Creates an event — response body — working Location Properties, Creates an event — request body — body attendees item, Creates an event — response body — creator, Creates an event — response body — extended Properties, Creates an event — request body — body gadget, Creates an event — response body — organizer, Creates an event — request body — body reminders

Returns events on the specified calendar — response body

Field	Type	Presence	Description and constraints
$	object	Root
accessRole	string	Optional	The user's access role for this calendar. Read-only. Possible values are: - "none" - The user has no access. - "freeBusyReader" - The user has read access to free/busy information. - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writerWithoutPrivateAccess" - The user has read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - The user has manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.
defaultReminders	array	Optional	The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True).
defaultReminders[]	Model	Each item	Expand Returns events on the specified calendar — response body — default Reminders item
description	string	Optional	Description of the calendar. Read-only.
etag	string	Optional	ETag of the collection.
items	array	Optional	List of events on the calendar.
items[]	Model	Each item	Expand Creates an event — response body
kind	string	Optional	Type of the collection ("calendar#events"). Default: calendar#events
nextPageToken	string	Optional	Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
nextSyncToken	string	Optional	Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
summary	string	Optional	Title of the calendar. Read-only.
timeZone	string	Optional	The time zone of the calendar. Read-only.
updated	string	Optional	Last modification time of the calendar (as a RFC3339 timestamp). Read-only. Format: date-time

Referenced models: Creates an event — response body, Returns events on the specified calendar — response body — default Reminders item

Returns events on the specified calendar — response body — default Reminders item

Field	Type	Presence	Description and constraints
$	object	Root
method	string	Optional	The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder.
minutes	JSON	Optional
minutes (anyOf 1)	integer	Alternative	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. Format: int32
minutes (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Updates an event This method supports patch semantics — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
anyoneCanAddSelf	boolean	Optional	Whether anyone can invite themselves to the event (deprecated). Optional. The default is False. Default: false
attachments	array	Optional	File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,
attachments[]	Model	Each item	Expand Creates an event — response body — attachments item
attendees	array	Optional	The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list.
attendees[]	Model	Each item	Expand Creates an event — request body — body attendees item
attendeesOmitted	boolean	Optional	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. Default: false
birthdayProperties	Model	Optional	Expand Creates an event — response body — birthday Properties Birthday or special event data. Used if eventType is "birthday". Immutable.
colorId	string	Optional	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.
conferenceData	Model	Optional	Expand Creates an event — response body — conference Data The conference-related information, such as details of a Google 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. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
created	string	Optional	Creation time of the event (as a RFC3339 timestamp). Read-only. Format: date-time
creator	Model	Optional	Expand Creates an event — response body — creator
description	string	Optional	Description of the event. Can contain HTML. Optional.
end	Model	Optional	Expand Creates an event — response body — end The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.
endTimeUnspecified	boolean	Optional	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. Default: false
etag	string	Optional	ETag of the resource.
eventLabelId	string	Optional	The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. Setting an empty string, or not setting this field at all, will remove the existing label from the event.
eventType	string	Optional	Specific type of the event. This cannot be modified after the event is created. Possible values are: - "birthday" - A special all-day event with an annual recurrence. - "default" - A regular event or not further specified. - "focusTime" - A focus-time event. - "fromGmail" - An event from Gmail. This type of event cannot be created. - "outOfOffice" - An out-of-office event. - "workingLocation" - A working location event. Default: default
extendedProperties	Model	Optional	Expand Creates an event — response body — extended Properties
focusTimeProperties	Model	Optional	Expand Creates an event — response body — focus Time Properties Focus Time event data. Used if eventType is focusTime.
gadget	Model	Optional	Expand Creates an event — request body — body gadget
guestsCanInviteOthers	boolean	Optional	Whether attendees other than the organizer can invite others to the event. Optional. The default is True. Default: true
guestsCanModify	boolean	Optional	Whether attendees other than the organizer can modify the event. Optional. The default is False. Default: false
guestsCanSeeOtherGuests	boolean	Optional	Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. Default: true
hangoutLink	string	Optional	An absolute link to the Google Hangout associated with this event. Read-only.
htmlLink	string	Optional	An absolute link to this event in the Google Calendar Web UI. Read-only.
iCalUID	string	Optional	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. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method.
id	string	Optional	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.
kind	string	Optional	Type of the resource ("calendar#event"). Default: calendar#event
location	string	Optional	Geographic location of the event as free-form text. Optional.
locked	boolean	Optional	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. Default: false
organizer	Model	Optional	Expand Creates an event — response body — organizer
originalStartTime	Model	Optional	Expand Creates an event — response body — end 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.
outOfOfficeProperties	Model	Optional	Expand Creates an event — response body — out Of Office Properties Out of office event data. Used if eventType is outOfOffice.
privateCopy	boolean	Optional	If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False. Default: false
recurrence	array	Optional	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.
recurrence[]	string	Each item
recurringEventId	string	Optional	For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.
reminders	Model	Optional	Expand Creates an event — request body — body reminders
sequence	integer	Optional	Sequence number as per iCalendar. Format: int32
source	object	Optional	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	Optional	Title of the source; for example a title of a web page or an email subject.
source.url	string	Optional	URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS.
start	Model	Optional	Expand Creates an event — response body — end The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.
status	string	Optional	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: - 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. - 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.
summary	string	Optional	Title of the event.
transparency	string	Optional	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. Default: opaque
updated	string	Optional	Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. Format: date-time
visibility	string	Optional	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. Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. Default: default
workingLocationProperties	Model	Optional	Expand Creates an event — response body — working Location Properties Working location event data.

Referenced models: Creates an event — response body — conference Data, Creates an event — response body — attachments item, Creates an event — response body — birthday Properties, Creates an event — response body — end, Creates an event — response body — focus Time Properties, Creates an event — response body — out Of Office Properties, Creates an event — response body — working Location Properties, Creates an event — request body — body attendees item, Creates an event — response body — creator, Creates an event — response body — extended Properties, Creates an event — request body — body gadget, Creates an event — response body — organizer, Creates an event — request body — body reminders

Updates an event — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIp	string	Optional	Deprecated. Please use quotaUser instead.
alwaysIncludeEmail	boolean	Optional	Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
conferenceDataVersion	integer	Optional	Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. Format: int32 Maximum: 1 Minimum: 0
eventLabelVersion	integer	Optional	Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0. Format: int32 Maximum: 1 Minimum: 0
maxAttendees	integer	Optional	The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. Format: int32 Minimum: 1
sendNotifications	boolean	Optional	Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
sendUpdates	string	Optional	Guests who should receive notifications about the event update (for example, title changes, etc.). One of: all, externalOnly, none
supportsAttachments	boolean	Optional	Whether API client performing operation supports event attachments. Optional. The default is False.

Watch for changes to Events resources — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Optional	Selector specifying which fields to include in a partial response.
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
userIp	string	Optional	Deprecated. Please use quotaUser instead.
alwaysIncludeEmail	boolean	Optional	Deprecated and ignored.
eventTypes	array	Optional
eventTypes[]	string	Each item	Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types. One of: birthday, default, focusTime, fromGmail, outOfOffice, workingLocation
iCalUID	string	Optional	Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.
maxAttendees	integer	Optional	The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. Format: int32 Minimum: 1
maxResults	integer	Optional	Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. Default: 250 Format: int32 Minimum: 1
orderBy	string	Optional	The order of the events returned in the result. Optional. The default is an unspecified, stable order. One of: startTime, updated
pageToken	string	Optional	Token specifying which result page to return. Optional.
privateExtendedProperty	array	Optional
privateExtendedProperty[]	string	Each item	Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
q	string	Optional	Free text search terms to find events that match these terms in the following fields: - summary - description - location - attendee's displayName - attendee's email - organizer's displayName - organizer's email - workingLocationProperties.officeLocation.buildingId - workingLocationProperties.officeLocation.deskId - workingLocationProperties.officeLocation.label - workingLocationProperties.customLocation.label These search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for "Office" or "Bureau" returns working location events of type officeLocation, whereas searching for "Out of office" or "Abwesend" returns out-of-office events. Optional.
sharedExtendedProperty	array	Optional
sharedExtendedProperty[]	string	Each item	Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
showDeleted	boolean	Optional	Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
showHiddenInvitations	boolean	Optional	Whether to include hidden invitations in the result. Optional. The default is False.
singleEvents	boolean	Optional	Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
syncToken	string	Optional	Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
timeMax	string	Optional	Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. Format: date-time
timeMin	string	Optional	Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. Format: date-time
timeZone	string	Optional	Time zone used in the response. Optional. The default is the time zone of the calendar.
updatedMin	string	Optional	Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. Format: date-time