grr
api reference · v3

Every Calendar method, from the index.

All 38 methods of the Calendar API, rendered at build time from the committed Discovery index the grr binary embeds — the same data grr api describe reads at runtime. Flags are kebab-cased parameter names: userId is --user-id.

38 methods · v3 · revision 20260826

calendar.acl

7 methods

calendar.acl.delete

DELETE

grr calendar acl delete calendars/{calendarId}/acl/{ruleId}

Deletes an access control rule.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
ruleId string yes — path ACL rule identifier. —

https://www.googleapis.com/auth/calendar.acls least privilege

2 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.acls

grr calendar acl delete 
grr calendar acl delete --calendar-id primary --rule-id <rule-id>

calendar.acl.get

GET

grr calendar acl get calendars/{calendarId}/acl/{ruleId}

Returns an access control rule.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
ruleId string yes — path ACL rule identifier. —

https://www.googleapis.com/auth/calendar.readonly least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.acls
  • https://www.googleapis.com/auth/calendar.acls.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar acl get 
grr calendar acl get --calendar-id primary --rule-id <rule-id>

calendar.acl.insert

POST

grr calendar acl insert calendars/{calendarId}/acl

Creates an access control rule.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
sendNotifications boolean — — query Whether to send notifications about the calendar sharing change. Optional. The default is True. —

https://www.googleapis.com/auth/calendar.acls least privilege

2 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.acls

grr calendar acl insert 
grr calendar acl insert --calendar-id primary --body-file ./body.json

calendar.acl.list

GET

grr calendar acl list calendars/{calendarId}/acl

Returns the rules in the access control list for the calendar.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
maxResults integer — — query Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. —
pageToken string — — query Token specifying which result page to return. Optional. —
showDeleted boolean — — query Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provid —
syncToken string — — query 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 contai —

https://www.googleapis.com/auth/calendar.acls.readonly least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.acls
  • https://www.googleapis.com/auth/calendar.acls.readonly

grr calendar acl list 
grr calendar acl list --calendar-id primary

calendar.acl.patch

PATCH

grr calendar acl patch calendars/{calendarId}/acl/{ruleId}

Updates an access control rule. This method supports patch semantics.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
ruleId string yes — path ACL rule identifier. —
sendNotifications boolean — — query Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. —

https://www.googleapis.com/auth/calendar.acls least privilege

2 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.acls

grr calendar acl patch 
grr calendar acl patch --calendar-id primary --rule-id <rule-id> --body-file ./body.json

calendar.acl.update

PUT

grr calendar acl update calendars/{calendarId}/acl/{ruleId}

Updates an access control rule.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
ruleId string yes — path ACL rule identifier. —
sendNotifications boolean — — query Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. —

https://www.googleapis.com/auth/calendar.acls least privilege

2 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.acls

grr calendar acl update 
grr calendar acl update --calendar-id primary --rule-id <rule-id> --body-file ./body.json

calendar.acl.watch

POST

grr calendar acl watch calendars/{calendarId}/acl/watch

Watch for changes to ACL resources.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
maxResults integer — — query Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. —
pageToken string — — query Token specifying which result page to return. Optional. —
showDeleted boolean — — query Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provid —
syncToken string — — query 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 contai —

https://www.googleapis.com/auth/calendar.acls.readonly least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.acls
  • https://www.googleapis.com/auth/calendar.acls.readonly

grr calendar acl watch 
grr calendar acl watch --calendar-id primary --body-file ./body.json

calendar.calendarList

7 methods

calendar.calendarList.delete

DELETE

grr calendar calendarList delete users/me/calendarList/{calendarId}

Removes a calendar from the user's calendar list.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —

https://www.googleapis.com/auth/calendar.calendarlist least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendarlist

grr calendar calendarList delete 
grr calendar calendarList delete --calendar-id primary

calendar.calendarList.get

GET

grr calendar calendarList get users/me/calendarList/{calendarId}

Returns a calendar from the user's calendar list.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —

https://www.googleapis.com/auth/calendar.readonly least privilege

5 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendarlist
  • https://www.googleapis.com/auth/calendar.calendarlist.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar calendarList get 
grr calendar calendarList get --calendar-id primary

calendar.calendarList.insert

POST

grr calendar calendarList insert users/me/calendarList

Inserts an existing calendar into the user's calendar list.

Parameter Type Required Repeated Location Description Enum values
colorRgbFormat boolean — — query Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be —

https://www.googleapis.com/auth/calendar.calendarlist least privilege

2 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendarlist

grr calendar calendarList insert 
grr calendar calendarList insert --body-file ./body.json

calendar.calendarList.list

GET

grr calendar calendarList list users/me/calendarList

Returns the calendars on the user's calendar list.

Parameter Type Required Repeated Location Description Enum values
maxResults integer — — query Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. —
minAccessRole string — — query The minimum access role for the user in the returned entries. Optional. The default is no restriction. freeBusyReader · owner · reader · writer · writerWithoutPrivateAccess
pageToken string — — query Token specifying which result page to return. Optional. —
showDeleted boolean — — query Whether to include deleted calendar list entries in the result. Optional. The default is False. —
showHidden boolean — — query Whether to show hidden entries. Optional. The default is False. —
showOwnOrganizationOnly boolean — — query Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False. —
syncToken string — — query 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 contai —

https://www.googleapis.com/auth/calendar.readonly least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendarlist
  • https://www.googleapis.com/auth/calendar.calendarlist.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar calendarList list 
grr calendar calendarList list

calendar.calendarList.patch

PATCH

grr calendar calendarList patch users/me/calendarList/{calendarId}

Updates an existing calendar on the user's calendar list. This method supports patch semantics.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
colorRgbFormat boolean — — query Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be —

https://www.googleapis.com/auth/calendar.calendarlist least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendarlist

grr calendar calendarList patch 
grr calendar calendarList patch --calendar-id primary --body-file ./body.json

calendar.calendarList.update

PUT

grr calendar calendarList update users/me/calendarList/{calendarId}

Updates an existing calendar on the user's calendar list.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
colorRgbFormat boolean — — query Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be —

https://www.googleapis.com/auth/calendar.calendarlist least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendarlist

grr calendar calendarList update 
grr calendar calendarList update --calendar-id primary --body-file ./body.json

calendar.calendarList.watch

POST

grr calendar calendarList watch users/me/calendarList/watch

Watch for changes to CalendarList resources.

Parameter Type Required Repeated Location Description Enum values
maxResults integer — — query Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. —
minAccessRole string — — query The minimum access role for the user in the returned entries. Optional. The default is no restriction. freeBusyReader · owner · reader · writer · writerWithoutPrivateAccess
pageToken string — — query Token specifying which result page to return. Optional. —
showDeleted boolean — — query Whether to include deleted calendar list entries in the result. Optional. The default is False. —
showHidden boolean — — query Whether to show hidden entries. Optional. The default is False. —
showOwnOrganizationOnly boolean — — query Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False. —
syncToken string — — query 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 contai —

https://www.googleapis.com/auth/calendar.readonly least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendarlist
  • https://www.googleapis.com/auth/calendar.calendarlist.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar calendarList watch 
grr calendar calendarList watch --body-file ./body.json

calendar.calendars

7 methods

calendar.calendars.clear

POST

grr calendar calendars clear calendars/{calendarId}/clear

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —

https://www.googleapis.com/auth/calendar.calendars least privilege

2 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars

grr calendar calendars clear 
grr calendar calendars clear --calendar-id primary --body-file ./body.json

calendar.calendars.delete

DELETE

grr calendar calendars delete calendars/{calendarId}

Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —

https://www.googleapis.com/auth/calendar.calendars least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendars

grr calendar calendars delete 
grr calendar calendars delete --calendar-id primary

calendar.calendars.get

GET

grr calendar calendars get calendars/{calendarId}

Returns metadata for a calendar.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —

https://www.googleapis.com/auth/calendar.readonly least privilege

5 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendars
  • https://www.googleapis.com/auth/calendar.calendars.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar calendars get 
grr calendar calendars get --calendar-id primary

calendar.calendars.insert

POST

grr calendar calendars insert calendars

Creates a secondary calendar. The authenticated user for the request is made the data owner of the new calendar. Note: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. D

No parameters.

https://www.googleapis.com/auth/calendar.calendars least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendars

grr calendar calendars insert 
grr calendar calendars insert --body-file ./body.json

calendar.calendars.patch

PATCH

grr calendar calendars patch calendars/{calendarId}

Updates metadata for a calendar. This method supports patch semantics.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —

https://www.googleapis.com/auth/calendar.calendars least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendars

grr calendar calendars patch 
grr calendar calendars patch --calendar-id primary --body-file ./body.json

calendar.calendars.transferOwnership

POST

grr calendar calendars transferOwnership calendars/{calendarId}/transferOwnership

Transfers a secondary calendar between users within a Google Workspace organization. Requires user authentication with Manage Calendars administrator privilege, and one of the following authorization scopes: - https://www.googleapis.com/auth/calendar - https://www.googleapis.com/auth/calendar.calend

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs, call the calendarList.list method. —
newDataOwner string yes — query The email address of a user who will become the data owner of the calendar. —
useAdminAccess boolean yes — query When true, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the Manage —

https://www.googleapis.com/auth/calendar.calendars least privilege

2 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.calendars

grr calendar calendars transferOwnership 
grr calendar calendars transferOwnership --calendar-id primary --new-data-owner <new-data-owner> --use-admin-access <use-admin-access> --body-file ./body.json

calendar.calendars.update

PUT

grr calendar calendars update calendars/{calendarId}

Updates metadata for a calendar.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —

https://www.googleapis.com/auth/calendar.calendars least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendars

grr calendar calendars update 
grr calendar calendars update --calendar-id primary --body-file ./body.json

calendar.channels

1 method

calendar.channels.stop

POST

grr calendar channels stop channels/stop

Stop watching resources through this channel

No parameters.

https://www.googleapis.com/auth/calendar.settings.readonly least privilege

14 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.acls
  • https://www.googleapis.com/auth/calendar.acls.readonly
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendarlist
  • https://www.googleapis.com/auth/calendar.calendarlist.readonly
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.freebusy
  • https://www.googleapis.com/auth/calendar.events.owned
  • https://www.googleapis.com/auth/calendar.events.owned.readonly
  • https://www.googleapis.com/auth/calendar.events.public.readonly
  • https://www.googleapis.com/auth/calendar.events.readonly
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.googleapis.com/auth/calendar.settings.readonly

grr calendar channels stop 
grr calendar channels stop --body-file ./body.json

calendar.colors

1 method

calendar.colors.get

GET

grr calendar colors get colors

Returns the color definitions for calendars and events.

No parameters.

https://www.googleapis.com/auth/calendar.readonly least privilege

9 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.calendarlist
  • https://www.googleapis.com/auth/calendar.calendarlist.readonly
  • https://www.googleapis.com/auth/calendar.events.freebusy
  • https://www.googleapis.com/auth/calendar.events.owned
  • https://www.googleapis.com/auth/calendar.events.owned.readonly
  • https://www.googleapis.com/auth/calendar.events.public.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar colors get 
grr calendar colors get

calendar.events

11 methods

calendar.events.delete

DELETE

grr calendar events delete calendars/{calendarId}/events/{eventId}

Deletes an event.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
eventId string yes — path Event identifier. —
sendNotifications boolean — — query Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you —
sendUpdates string — — query Guests who should receive notifications about the deletion of the event. all · externalOnly · none

https://www.googleapis.com/auth/calendar.events.owned least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.owned

grr calendar events delete 
grr calendar events delete --calendar-id primary --event-id <event-id>

calendar.events.get

GET

grr calendar events get calendars/{calendarId}/events/{eventId}

Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.

Parameter Type Required Repeated Location Description Enum values
alwaysIncludeEmail boolean — — query 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 —
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
eventId string yes — path Event identifier. —
maxAttendees integer — — query 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 —
timeZone string — — query Time zone used in the response. Optional. The default is the time zone of the calendar. —

https://www.googleapis.com/auth/calendar.readonly least privilege

9 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.freebusy
  • https://www.googleapis.com/auth/calendar.events.owned
  • https://www.googleapis.com/auth/calendar.events.owned.readonly
  • https://www.googleapis.com/auth/calendar.events.public.readonly
  • https://www.googleapis.com/auth/calendar.events.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar events get 
grr calendar events get --calendar-id primary --event-id <event-id>

calendar.events.import

POST

grr calendar events import calendars/{calendarId}/events/import

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

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
conferenceDataVersion integer — — query 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. Ver —
eventLabelVersion integer — — query 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 manage —
supportsAttachments boolean — — query Whether API client performing operation supports event attachments. Optional. The default is False. —

https://www.googleapis.com/auth/calendar.events.owned least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.owned

grr calendar events import 
grr calendar events import --calendar-id primary --body-file ./body.json

calendar.events.insert

POST

grr calendar events insert calendars/{calendarId}/events

Creates an event.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
conferenceDataVersion integer — — query 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. Ver —
eventLabelVersion integer — — query 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 manage —
maxAttendees integer — — query 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 —
sendNotifications boolean — — query Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if —
sendUpdates string — — query Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. all · externalOnly · none
supportsAttachments boolean — — query Whether API client performing operation supports event attachments. Optional. The default is False. —

https://www.googleapis.com/auth/calendar.events.owned least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.owned

grr calendar events insert 
grr calendar events insert --calendar-id primary --body-file ./body.json

calendar.events.instances

GET

grr calendar events instances calendars/{calendarId}/events/{eventId}/instances

Returns instances of the specified recurring event.

Parameter Type Required Repeated Location Description Enum values
alwaysIncludeEmail boolean — — query 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 —
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
eventId string yes — path Recurring event identifier. —
maxAttendees integer — — query 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 —
maxResults integer — — query Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. —
originalStart string — — query The original start time of the instance in the result. Optional. —
pageToken string — — query Token specifying which result page to return. Optional. —
showDeleted boolean — — query Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents —
timeMax string — — query 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 mandator —
timeMin string — — query Lower bound (inclusive) 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 ti —
timeZone string — — query Time zone used in the response. Optional. The default is the time zone of the calendar. —

https://www.googleapis.com/auth/calendar.readonly least privilege

9 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.freebusy
  • https://www.googleapis.com/auth/calendar.events.owned
  • https://www.googleapis.com/auth/calendar.events.owned.readonly
  • https://www.googleapis.com/auth/calendar.events.public.readonly
  • https://www.googleapis.com/auth/calendar.events.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar events instances 
grr calendar events instances --calendar-id primary --event-id <event-id>

calendar.events.list

GET

grr calendar events list calendars/{calendarId}/events

Returns events on the specified calendar.

Parameter Type Required Repeated Location Description Enum values
alwaysIncludeEmail boolean — — query Deprecated and ignored. —
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
eventTypes string — yes query Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types. birthday · default · focusTime · fromGmail · outOfOffice · workingLocation
iCalUID string — — query 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 — — query 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 —
maxResults integer — — query 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 —
orderBy string — — query The order of the events returned in the result. Optional. The default is an unspecified, stable order. startTime · updated
pageToken string — — query Token specifying which result page to return. Optional. —
privateExtendedProperty string — yes query Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return event —
q string — — query Free text search terms to find events that match these terms in the following fields: - summary - description - location - attendee's displayName - attendee's e —
sharedExtendedProperty string — yes query Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events —
showDeleted boolean — — query Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring even —
showHiddenInvitations boolean — — query Whether to include hidden invitations in the result. Optional. The default is False. —
singleEvents boolean — — query Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring even —
syncToken string — — query 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 contai —
timeMax string — — query 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 mandator —
timeMin string — — query 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 ti —
timeZone string — — query Time zone used in the response. Optional. The default is the time zone of the calendar. —
updatedMin string — — query 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 —

https://www.googleapis.com/auth/calendar.readonly least privilege

9 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.freebusy
  • https://www.googleapis.com/auth/calendar.events.owned
  • https://www.googleapis.com/auth/calendar.events.owned.readonly
  • https://www.googleapis.com/auth/calendar.events.public.readonly
  • https://www.googleapis.com/auth/calendar.events.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar events list 
grr calendar events list --calendar-id primary

calendar.events.move

POST

grr calendar events move calendars/{calendarId}/events/{eventId}/move

Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier of the source calendar where the event currently is on. —
destination string yes — query Calendar identifier of the target calendar where the event is to be moved to. —
eventId string yes — path Event identifier. —
sendNotifications boolean — — query Deprecated. Please use sendUpdates instead. Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent e —
sendUpdates string — — query Guests who should receive notifications about the change of the event's organizer. all · externalOnly · none

https://www.googleapis.com/auth/calendar.events.owned least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.owned

grr calendar events move 
grr calendar events move --calendar-id primary --destination <destination> --event-id <event-id> --body-file ./body.json

calendar.events.patch

PATCH

grr calendar events patch calendars/{calendarId}/events/{eventId}

Updates an event. This method supports patch semantics.

Parameter Type Required Repeated Location Description Enum values
alwaysIncludeEmail boolean — — query 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 —
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
conferenceDataVersion integer — — query 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. Ver —
eventId string yes — path Event identifier. —
eventLabelVersion integer — — query 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 manage —
maxAttendees integer — — query 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 —
sendNotifications boolean — — query Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails —
sendUpdates string — — query Guests who should receive notifications about the event update (for example, title changes, etc.). all · externalOnly · none
supportsAttachments boolean — — query Whether API client performing operation supports event attachments. Optional. The default is False. —

https://www.googleapis.com/auth/calendar.events.owned least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.owned

grr calendar events patch 
grr calendar events patch --calendar-id primary --event-id <event-id> --body-file ./body.json

calendar.events.quickAdd

POST

grr calendar events quickAdd calendars/{calendarId}/events/quickAdd

Creates an event based on a simple text string.

Parameter Type Required Repeated Location Description Enum values
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
sendNotifications boolean — — query Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you —
sendUpdates string — — query Guests who should receive notifications about the creation of the new event. all · externalOnly · none
text string yes — query The text describing the event to be created. —

https://www.googleapis.com/auth/calendar.events.owned least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.owned

grr calendar events quickAdd 
grr calendar events quickAdd --calendar-id primary --text <text> --body-file ./body.json

calendar.events.update

PUT

grr calendar events update calendars/{calendarId}/events/{eventId}

Updates an event.

Parameter Type Required Repeated Location Description Enum values
alwaysIncludeEmail boolean — — query 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 —
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
conferenceDataVersion integer — — query 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. Ver —
eventId string yes — path Event identifier. —
eventLabelVersion integer — — query 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 manage —
maxAttendees integer — — query 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 —
sendNotifications boolean — — query Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails —
sendUpdates string — — query Guests who should receive notifications about the event update (for example, title changes, etc.). all · externalOnly · none
supportsAttachments boolean — — query Whether API client performing operation supports event attachments. Optional. The default is False. —

https://www.googleapis.com/auth/calendar.events.owned least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.owned

grr calendar events update 
grr calendar events update --calendar-id primary --event-id <event-id> --body-file ./body.json

calendar.events.watch

POST

grr calendar events watch calendars/{calendarId}/events/watch

Watch for changes to Events resources.

Parameter Type Required Repeated Location Description Enum values
alwaysIncludeEmail boolean — — query Deprecated and ignored. —
calendarId string yes — path Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use —
eventTypes string — yes query Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types. birthday · default · focusTime · fromGmail · outOfOffice · workingLocation
iCalUID string — — query 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 — — query 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 —
maxResults integer — — query 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 —
orderBy string — — query The order of the events returned in the result. Optional. The default is an unspecified, stable order. startTime · updated
pageToken string — — query Token specifying which result page to return. Optional. —
privateExtendedProperty string — yes query Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return event —
q string — — query Free text search terms to find events that match these terms in the following fields: - summary - description - location - attendee's displayName - attendee's e —
sharedExtendedProperty string — yes query Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events —
showDeleted boolean — — query Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring even —
showHiddenInvitations boolean — — query Whether to include hidden invitations in the result. Optional. The default is False. —
singleEvents boolean — — query Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring even —
syncToken string — — query 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 contai —
timeMax string — — query 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 mandator —
timeMin string — — query 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 ti —
timeZone string — — query Time zone used in the response. Optional. The default is the time zone of the calendar. —
updatedMin string — — query 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 —

https://www.googleapis.com/auth/calendar.readonly least privilege

9 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.app.created
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.freebusy
  • https://www.googleapis.com/auth/calendar.events.owned
  • https://www.googleapis.com/auth/calendar.events.owned.readonly
  • https://www.googleapis.com/auth/calendar.events.public.readonly
  • https://www.googleapis.com/auth/calendar.events.readonly
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar events watch 
grr calendar events watch --calendar-id primary --body-file ./body.json

calendar.freebusy

1 method

calendar.freebusy.query

POST

grr calendar freebusy query freeBusy

Returns free/busy information for a set of calendars.

No parameters.

https://www.googleapis.com/auth/calendar.readonly least privilege

4 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.events.freebusy
  • https://www.googleapis.com/auth/calendar.freebusy
  • https://www.googleapis.com/auth/calendar.readonly

grr calendar freebusy query 
grr calendar freebusy query --body-file ./body.json

calendar.settings

3 methods

calendar.settings.get

GET

grr calendar settings get users/me/settings/{setting}

Returns a single user setting.

Parameter Type Required Repeated Location Description Enum values
setting string yes — path The id of the user setting. —

https://www.googleapis.com/auth/calendar.settings.readonly least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.googleapis.com/auth/calendar.settings.readonly

grr calendar settings get 
grr calendar settings get --setting <setting>

calendar.settings.list

GET

grr calendar settings list users/me/settings

Returns all user settings for the authenticated user.

Parameter Type Required Repeated Location Description Enum values
maxResults integer — — query Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. —
pageToken string — — query Token specifying which result page to return. Optional. —
syncToken string — — query 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 contai —

https://www.googleapis.com/auth/calendar.settings.readonly least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.googleapis.com/auth/calendar.settings.readonly

grr calendar settings list 
grr calendar settings list

calendar.settings.watch

POST

grr calendar settings watch users/me/settings/watch

Watch for changes to Settings resources.

Parameter Type Required Repeated Location Description Enum values
maxResults integer — — query Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. —
pageToken string — — query Token specifying which result page to return. Optional. —
syncToken string — — query 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 contai —

https://www.googleapis.com/auth/calendar.settings.readonly least privilege

3 scopes
  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.googleapis.com/auth/calendar.settings.readonly

grr calendar settings watch 
grr calendar settings watch --body-file ./body.json