Skip to content
tooluse.net logotooluse.net

Google Calendar

Updated View as Markdown

Read calendars, events, availability, settings and access rules; create, update, move or delete calendar resources through Google Calendar v3. Each command uses explicit calendar/event IDs and one page or request. Pagination cursors and timezones stay intact. Mutations can notify attendees or change access; review sendUpdates and permissions before enabling them. Read-only selections request calendar read access; enabling writes requires renewed authorization.

What you can do (38)

What you can do

Available commands: 38 (11 read, 27 write). Enable only the commands your application needs.

Command Effect
Deletes an access control rule. — google-calendar.calendar.acl.delete Write
Returns an access control rule. — google-calendar.calendar.acl.get Read
Creates an access control rule. — google-calendar.calendar.acl.insert Write
Returns the rules in the access control list for the calendar. — google-calendar.calendar.acl.list Read
Updates an access control rule — google-calendar.calendar.acl.patch Write
Updates an access control rule. — google-calendar.calendar.acl.update Write
Watch for changes to ACL resources. — google-calendar.calendar.acl.watch Write
Removes a calendar from the user's calendar list. — google-calendar.calendar.calendarlist.delete Write
Returns a calendar from the user's calendar list. — google-calendar.calendar.calendarlist.get Read
Inserts an existing calendar into the user's calendar list. — google-calendar.calendar.calendarlist.insert Write
Returns the calendars on the user's calendar list. — google-calendar.calendar.calendarlist.list Read
Updates an existing calendar on the user's calendar list — google-calendar.calendar.calendarlist.patch Write
Updates an existing calendar on the user's calendar list. — google-calendar.calendar.calendarlist.update Write
Watch for changes to CalendarList resources. — google-calendar.calendar.calendarlist.watch Write
Clears a primary calendar — google-calendar.calendar.calendars.clear Write
Deletes a secondary calendar — google-calendar.calendar.calendars.delete Write
Returns metadata for a calendar. — google-calendar.calendar.calendars.get Read
Creates a secondary calendar — google-calendar.calendar.calendars.insert Write
Updates metadata for a calendar — google-calendar.calendar.calendars.patch Write
Transfers a secondary calendar between users within a Google Workspace organization — google-calendar.calendar.calendars.transferownership Write
Updates metadata for a calendar. — google-calendar.calendar.calendars.update Write
Stop watching resources through this channel — google-calendar.calendar.channels.stop Write
Returns the color definitions for calendars and events. — google-calendar.calendar.colors.get Read
Deletes an event. — google-calendar.calendar.events.delete Write
Returns an event based on its Google Calendar ID — google-calendar.calendar.events.get Read
Imports an event — google-calendar.calendar.events.import Write
Creates an event. — google-calendar.calendar.events.insert Write
Returns instances of the specified recurring event. — google-calendar.calendar.events.instances Read
Returns events on the specified calendar. — google-calendar.calendar.events.list Read
Moves an event to another calendar, i.e — google-calendar.calendar.events.move Write
Updates an event — google-calendar.calendar.events.patch Write
Creates an event based on a simple text string. — google-calendar.calendar.events.quickadd Write
Updates an event. — google-calendar.calendar.events.update Write
Watch for changes to Events resources. — google-calendar.calendar.events.watch Write
Returns free/busy information for a set of calendars. — google-calendar.calendar.freebusy.query Write
Returns a single user setting. — google-calendar.calendar.settings.get Read
Returns all user settings for the authenticated user. — google-calendar.calendar.settings.list Read
Watch for changes to Settings resources. — google-calendar.calendar.settings.watch Write

Connect and use

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for Google Calendar, then enter the issued values in the connection form below.

  1. In an existing Google Cloud project, enable Google Calendar API and reuse or create a Web application OAuth client. Register https://api.tooluse.net/v1/oauth/callback as an authorized redirect URI, or enter your separately registered redirect URI in this connection. Fill Google OAuth client ID and secret, choose commands, save, then Sign in to provider. Read commands request calendar.readonly; enabling writes requires fresh consent for calendar access. Consent-screen publishing and Google verification may be required. An existing access token is optional and expires; an API key alone cannot authorize private calendars. Use calendar and event IDs; review sendUpdates before changes that may notify attendees. Create a separate Tooluse.net API key for your client.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
Google access token (optional with OAuth) Optional
Google OAuth client ID Optional
Google OAuth client secret Optional
Registered OAuth redirect URI (optional) Optional
Return URL after authorization Optional

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {
    "path": {
      "calendarId": "example",
      "ruleId": "example"
    }
  }
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

Deletes an access control rule. — google-calendar.calendar.acl.delete

Run Deletes an access control rule. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
path.ruleId string Required ACL rule identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example",
    "ruleId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns an access control rule. — google-calendar.calendar.acl.get

Run Returns an access control rule. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
path.ruleId string Required ACL rule identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example",
    "ruleId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates an access control rule. — google-calendar.calendar.acl.insert

Run Creates an access control rule. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.sendNotifications boolean Optional Whether to send notifications about the calendar sharing change. Optional. The default is True.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
body — Required $ref: "#/definitions/AclRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  },
  "body": {
    "role": "example",
    "scope": {
      "type": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns the rules in the access control list for the calendar. — google-calendar.calendar.acl.list

Run Returns the rules in the access control list for the calendar. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.maxResults integer Optional 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. minimum: 1
query.pageToken string Optional Token specifying which result page to return. Optional.
query.showDeleted boolean Optional 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 provided. Optional. The default is False.
query.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 entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. 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.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates an access control rule — google-calendar.calendar.acl.patch

Run Updates an access control rule with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.sendNotifications boolean Optional Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
path.ruleId string Required ACL rule identifier.
body — Required $ref: "#/definitions/AclRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example",
    "ruleId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates an access control rule. — google-calendar.calendar.acl.update

Run Updates an access control rule. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.sendNotifications boolean Optional Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
path.ruleId string Required ACL rule identifier.
body — Required $ref: "#/definitions/AclRule"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example",
    "ruleId": "example"
  },
  "body": {
    "scope": {
      "type": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Watch for changes to ACL resources. — google-calendar.calendar.acl.watch

Run Watch for changes to ACL resources. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.maxResults integer Optional 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. minimum: 1
query.pageToken string Optional Token specifying which result page to return. Optional.
query.showDeleted boolean Optional 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 provided. Optional. The default is False.
query.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 entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. 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.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
body — Required $ref: "#/definitions/Channel"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Removes a calendar from the user's calendar list. — google-calendar.calendar.calendarlist.delete

Run Removes a calendar from the user's calendar list. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns a calendar from the user's calendar list. — google-calendar.calendar.calendarlist.get

Run Returns a calendar from the user's calendar list. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Inserts an existing calendar into the user's calendar list. — google-calendar.calendar.calendarlist.insert

Run Inserts an existing calendar into the user's calendar list. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.colorRgbFormat boolean Optional 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 set to the best matching option automatically. Optional. The default is False.
body — Required $ref: "#/definitions/CalendarListEntry"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns the calendars on the user's calendar list. — google-calendar.calendar.calendarlist.list

Run Returns the calendars on the user's calendar list. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.maxResults integer Optional 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. minimum: 1
query.minAccessRole string Optional The minimum access role for the user in the returned entries. Optional. The default is no restriction. enum: ["freeBusyReader","owner","reader","writer","writerWithoutPrivateAccess"]
query.pageToken string Optional Token specifying which result page to return. Optional.
query.showDeleted boolean Optional Whether to include deleted calendar list entries in the result. Optional. The default is False.
query.showHidden boolean Optional Whether to show hidden entries. Optional. The default is False.
query.showOwnOrganizationOnly boolean Optional Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.
query.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. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken. 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.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates an existing calendar on the user's calendar list — google-calendar.calendar.calendarlist.patch

Run Updates an existing calendar on the user's calendar list with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.colorRgbFormat boolean Optional 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 set to the best matching option automatically. Optional. The default is False.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
body — Required $ref: "#/definitions/CalendarListEntry"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates an existing calendar on the user's calendar list. — google-calendar.calendar.calendarlist.update

Run Updates an existing calendar on the user's calendar list. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.colorRgbFormat boolean Optional 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 set to the best matching option automatically. Optional. The default is False.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
body — Required $ref: "#/definitions/CalendarListEntry"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Watch for changes to CalendarList resources. — google-calendar.calendar.calendarlist.watch

Run Watch for changes to CalendarList resources. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.maxResults integer Optional 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. minimum: 1
query.minAccessRole string Optional The minimum access role for the user in the returned entries. Optional. The default is no restriction. enum: ["freeBusyReader","owner","reader","writer","writerWithoutPrivateAccess"]
query.pageToken string Optional Token specifying which result page to return. Optional.
query.showDeleted boolean Optional Whether to include deleted calendar list entries in the result. Optional. The default is False.
query.showHidden boolean Optional Whether to show hidden entries. Optional. The default is False.
query.showOwnOrganizationOnly boolean Optional Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.
query.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. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken. 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.
body — Required $ref: "#/definitions/Channel"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Clears a primary calendar — google-calendar.calendar.calendars.clear

Run Clears a primary calendar with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deletes a secondary calendar — google-calendar.calendar.calendars.delete

Run Deletes a secondary calendar with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns metadata for a calendar. — google-calendar.calendar.calendars.get

Run Returns metadata for a calendar. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates a secondary calendar — google-calendar.calendar.calendars.insert

Run Creates a secondary calendar with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
body — Required $ref: "#/definitions/Calendar"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "summary": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates metadata for a calendar — google-calendar.calendar.calendars.patch

Run Updates metadata for a calendar with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
body — Required $ref: "#/definitions/Calendar"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Transfers a secondary calendar between users within a Google Workspace organization — google-calendar.calendar.calendars.transferownership

Run Transfers a secondary calendar between users within a Google Workspace organization with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.newDataOwner string Required The email address of a user who will become the data owner of the calendar.
query.useAdminAccess boolean Required 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 Calendars privilege. This method currently only supports admin access, thus only true is accepted for this field.
path object Required additionalProperties: false
path.calendarId string Required Calendar identifier. To retrieve calendar IDs, call the calendarList.list method.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "newDataOwner": "example",
    "useAdminAccess": false
  },
  "path": {
    "calendarId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates metadata for a calendar. — google-calendar.calendar.calendars.update

Run Updates metadata for a calendar. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
body — Required $ref: "#/definitions/Calendar"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop watching resources through this channel — google-calendar.calendar.channels.stop

Run Stop watching resources through this channel with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
body — Required $ref: "#/definitions/Channel"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns the color definitions for calendars and events. — google-calendar.calendar.colors.get

Run Returns the color definitions for calendars and events. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Deletes an event. — google-calendar.calendar.events.delete

Run Deletes an event. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.sendNotifications boolean Optional 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 set the value to false. The default is false.
query.sendUpdates string Optional Guests who should receive notifications about the deletion of the event. enum: ["all","externalOnly","none"]
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
path.eventId string Required Event identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example",
    "eventId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns an event based on its Google Calendar ID — google-calendar.calendar.events.get

Run Returns an event based on its Google Calendar ID with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.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).
query.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. minimum: 1
query.timeZone string Optional Time zone used in the response. Optional. The default is the time zone of the calendar.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
path.eventId string Required Event identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example",
    "eventId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Imports an event — google-calendar.calendar.events.import

Run Imports an event with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.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. minimum: 0; maximum: 1
query.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. minimum: 0; maximum: 1
query.supportsAttachments boolean Optional Whether API client performing operation supports event attachments. Optional. The default is False.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
body — Required $ref: "#/definitions/Event"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  },
  "body": {
    "end": {},
    "iCalUID": "example",
    "start": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates an event. — google-calendar.calendar.events.insert

Run Creates an event. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.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. minimum: 0; maximum: 1
query.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. minimum: 0; maximum: 1
query.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. minimum: 1
query.sendNotifications boolean Optional 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 you set the value to false. The default is false.
query.sendUpdates string Optional Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. enum: ["all","externalOnly","none"]
query.supportsAttachments boolean Optional Whether API client performing operation supports event attachments. Optional. The default is False.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
body — Required $ref: "#/definitions/Event"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  },
  "body": {
    "end": {},
    "start": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns instances of the specified recurring event. — google-calendar.calendar.events.instances

Run Returns instances of the specified recurring event. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.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).
query.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. minimum: 1
query.maxResults integer Optional 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. minimum: 1
query.originalStart string Optional The original start time of the instance in the result. Optional.
query.pageToken string Optional Token specifying which result page to return. Optional.
query.showDeleted boolean Optional Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.
query.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. format: "date-time"
query.timeMin string Optional 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 time zone offset. format: "date-time"
query.timeZone string Optional Time zone used in the response. Optional. The default is the time zone of the calendar.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
path.eventId string Required Recurring event identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example",
    "eventId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns events on the specified calendar. — google-calendar.calendar.events.list

Run Returns events on the specified calendar. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.alwaysIncludeEmail boolean Optional Deprecated and ignored.
query.eventTypes array Optional
query.eventTypes[] string Optional Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types. enum: ["birthday","default","focusTime","fromGmail","outOfOffice","workingLocation"]
query.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.
query.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. minimum: 1
query.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; minimum: 1
query.orderBy string Optional The order of the events returned in the result. Optional. The default is an unspecified, stable order. enum: ["startTime","updated"]
query.pageToken string Optional Token specifying which result page to return. Optional.
query.privateExtendedProperty array Optional
query.privateExtendedProperty[] string Optional 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.
query.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.
query.sharedExtendedProperty array Optional
query.sharedExtendedProperty[] string Optional 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.
query.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.
query.showHiddenInvitations boolean Optional Whether to include hidden invitations in the result. Optional. The default is False.
query.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.
query.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.
query.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"
query.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"
query.timeZone string Optional Time zone used in the response. Optional. The default is the time zone of the calendar.
query.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"
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Moves an event to another calendar, i.e — google-calendar.calendar.events.move

Run Moves an event to another calendar, i.e with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.destination string Required Calendar identifier of the target calendar where the event is to be moved to.
query.sendNotifications boolean Optional 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 even if you set the value to false. The default is false.
query.sendUpdates string Optional Guests who should receive notifications about the change of the event's organizer. enum: ["all","externalOnly","none"]
path object Required additionalProperties: false
path.calendarId string Required Calendar identifier of the source calendar where the event currently is on.
path.eventId string Required Event identifier.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "destination": "example"
  },
  "path": {
    "calendarId": "example",
    "eventId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates an event — google-calendar.calendar.events.patch

Run Updates an event with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.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).
query.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. minimum: 0; maximum: 1
query.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. minimum: 0; maximum: 1
query.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. minimum: 1
query.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.
query.sendUpdates string Optional Guests who should receive notifications about the event update (for example, title changes, etc.). enum: ["all","externalOnly","none"]
query.supportsAttachments boolean Optional Whether API client performing operation supports event attachments. Optional. The default is False.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
path.eventId string Required Event identifier.
body — Required $ref: "#/definitions/Event"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example",
    "eventId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Creates an event based on a simple text string. — google-calendar.calendar.events.quickadd

Run Creates an event based on a simple text string. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.sendNotifications boolean Optional 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 set the value to false. The default is false.
query.sendUpdates string Optional Guests who should receive notifications about the creation of the new event. enum: ["all","externalOnly","none"]
query.text string Required The text describing the event to be created.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "text": "example"
  },
  "path": {
    "calendarId": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Updates an event. — google-calendar.calendar.events.update

Run Updates an event. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.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).
query.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. minimum: 0; maximum: 1
query.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. minimum: 0; maximum: 1
query.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. minimum: 1
query.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.
query.sendUpdates string Optional Guests who should receive notifications about the event update (for example, title changes, etc.). enum: ["all","externalOnly","none"]
query.supportsAttachments boolean Optional Whether API client performing operation supports event attachments. Optional. The default is False.
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
path.eventId string Required Event identifier.
body — Required $ref: "#/definitions/Event"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example",
    "eventId": "example"
  },
  "body": {
    "end": {},
    "start": {}
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Watch for changes to Events resources. — google-calendar.calendar.events.watch

Run Watch for changes to Events resources. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.alwaysIncludeEmail boolean Optional Deprecated and ignored.
query.eventTypes array Optional
query.eventTypes[] string Optional Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types. enum: ["birthday","default","focusTime","fromGmail","outOfOffice","workingLocation"]
query.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.
query.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. minimum: 1
query.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; minimum: 1
query.orderBy string Optional The order of the events returned in the result. Optional. The default is an unspecified, stable order. enum: ["startTime","updated"]
query.pageToken string Optional Token specifying which result page to return. Optional.
query.privateExtendedProperty array Optional
query.privateExtendedProperty[] string Optional 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.
query.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.
query.sharedExtendedProperty array Optional
query.sharedExtendedProperty[] string Optional 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.
query.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.
query.showHiddenInvitations boolean Optional Whether to include hidden invitations in the result. Optional. The default is False.
query.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.
query.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.
query.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"
query.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"
query.timeZone string Optional Time zone used in the response. Optional. The default is the time zone of the calendar.
query.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"
path object Required additionalProperties: false
path.calendarId string Required 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 the "primary" keyword.
body — Required $ref: "#/definitions/Channel"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "calendarId": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns free/busy information for a set of calendars. — google-calendar.calendar.freebusy.query

Run Returns free/busy information for a set of calendars. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
body — Required $ref: "#/definitions/FreeBusyRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns a single user setting. — google-calendar.calendar.settings.get

Run Returns a single user setting. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
path object Required additionalProperties: false
path.setting string Required The id of the user setting.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "setting": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns all user settings for the authenticated user. — google-calendar.calendar.settings.list

Run Returns all user settings for the authenticated user. with Google Calendar. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.maxResults integer Optional 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. minimum: 1
query.pageToken string Optional Token specifying which result page to return. Optional.
query.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. 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.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Watch for changes to Settings resources. — google-calendar.calendar.settings.watch

Run Watch for changes to Settings resources. with Google Calendar. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.fields string Optional Selector specifying which fields to include in a partial response.
query.prettyPrint boolean Optional Returns response with indentations and line breaks. default: true
query.maxResults integer Optional 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. minimum: 1
query.pageToken string Optional Token specifying which result page to return. Optional.
query.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. 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.
body — Required $ref: "#/definitions/Channel"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Navigation

Type to search…

↑↓ navigate↵ selectEsc close