Googlecalendar | Composio Docs

Overview

SLUG: GOOGLECALENDAR

Description

Google Calendar is a time management tool providing scheduling features, event reminders, and integration with email and other apps for streamlined organization

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

stringDefaults to https://www.googleapis.com/auth/calendar,https://www.googleapis.com/auth/calendar.events

bearer_token

string

Bearer Token

token

stringRequired

Connecting to Googlecalendar

Create an auth config

Use the dashboard to create an auth config for the Googlecalendar toolkit. This allows you to connect multiple Googlecalendar accounts to Composio for agents to use.

Select App

Navigate to Googlecalendar.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Googlecalendar Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1 from composio import Composio
2 
3 # Replace these with your actual values
4 googlecalendar_auth_config_id = "ac_YOUR_GOOGLECALENDAR_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/application
6 
7 composio = Composio()
8 
9 
10 def authenticate_toolkit(user_id: str, auth_config_id: str):
11     connection_request = composio.connected_accounts.initiate(
12         user_id=user_id,
13         auth_config_id=auth_config_id,
14     )
15 
16     print(
17         f"Visit this URL to authenticate Googlecalendar: {connection_request.redirect_url}"
18     )
19 
20     # This will wait for the auth flow to be completed
21     connection_request.wait_for_connection(timeout=15)
22     return connection_request.id
23 
24 
25 connection_id = authenticate_toolkit(user_id, googlecalendar_auth_config_id)
26 
27 # You can also verify the connection status using:
28 connected_account = composio.connected_accounts.get(connection_id)
29 print(f"Connected account: {connected_account}")

Using Bearer Token

1 from composio import Composio
2 
3 # Auth config ID created above
4 googlecalendar_auth_config_id = "ac_YOUR_GOOGLECALENDAR_CONFIG_ID" 
5 
6 # UUID from database/application
7 user_id = "0000-0000-0000"
8 
9 composio = Composio()
10 
11 
12 def authenticate_toolkit(user_id: str, auth_config_id: str):
13     # Replace this with a method to retrieve the Bearer Token from the user.
14     bearer_token = input("[!] Enter bearer token")
15     connection_request = composio.connected_accounts.initiate(
16         user_id=user_id,
17         auth_config_id=auth_config_id,
18         config={"auth_scheme": "BEARER_TOKEN", "val": bearer_token}
19     )
20     print(f"Successfully connected Googlecalendar for user {user_id}")
21     print(f"Connection status: {connection_request.status}")
22     
23     return connection_request.id
24 
25 
26 connection_id = authenticate_toolkit(user_id, googlecalendar_auth_config_id)
27 
28 # You can verify the connection using:
29 connected_account = composio.connected_accounts.get(connection_id)
30 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Googlecalendar toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["GOOGLECALENDAR"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

GOOGLECALENDAR_CALENDARS_DELETE

Tool Name: Delete Calendar

Description

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

Action Parameters

calendar_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_CALENDARS_UPDATE

Tool Name: Update Calendar

Description

Updates metadata for a calendar.

Action Parameters

calendarId

stringRequired

description

string

location

string

summary

stringRequired

timeZone

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_CALENDAR_LIST_INSERT

Tool Name: Insert Calendar into List

Description

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

Action Parameters

background_color

string

color_id

string

color_rgb_format

boolean

default_reminders

array

foreground_color

string

hidden

boolean

stringRequired

notification_settings

object

selected

boolean

summary_override

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_CREATE_EVENT

Tool Name: Create Event

Description

Creates an event on a google calendar, needing rfc3339 utc start/end times (end after start) and write access to the calendar. by default, adds the organizer as an attendee unless exclude organizer is set to true.

Action Parameters

attendees

array

calendar_id

stringDefaults to primary

create_meeting_room

boolean

description

string

eventType

stringDefaults to default

event_duration_hour

integer

event_duration_minutes

integerDefaults to 30

exclude_organizer

boolean

guestsCanInviteOthers

boolean

guestsCanSeeOtherGuests

boolean

guests_can_modify

boolean

location

string

recurrence

array

send_updates

boolean

start_datetime

stringRequired

summary

string

timezone

string

transparency

stringDefaults to opaque

visibility

stringDefaults to default

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_DELETE_EVENT

Tool Name: Delete event

Description

Deletes a specified event by `event id` from a google calendar (`calendar id`); this action is idempotent and raises a 404 error if the event is not found.

Action Parameters

calendar_id

stringDefaults to primary

event_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_DUPLICATE_CALENDAR

Tool Name: Create a calendar

Description

Creates a new, empty google calendar with the specified title (summary).

Action Parameters

summary

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_EVENTS_INSTANCES

Tool Name: Get Event Instances

Description

Returns instances of the specified recurring event.

Action Parameters

calendarId

stringRequired

eventId

stringRequired

maxAttendees

integer

maxResults

integer

originalStart

string

pageToken

string

showDeleted

boolean

timeMax

string

timeMin

string

timeZone

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_FIND_EVENT

Tool Name: Find event

Description

Finds events in a specified google calendar using text query, time ranges (event start/end, last modification), and event types; ensure `timemin` is not chronologically after `timemax` if both are provided.

Action Parameters

calendar_id

stringDefaults to primary

event_types

arrayDefaults to ['default', 'outOfOffice', 'focusTime', 'workingLocation']

max_results

integerDefaults to 10

order_by

string

page_token

string

query

string

show_deleted

boolean

single_events

booleanDefaults to True

timeMax

string

timeMin

string

updated_min

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_FREE_BUSY_QUERY

Tool Name: Query Free/Busy Information

Description

Returns free/busy information for a set of calendars.

Action Parameters

calendarExpansionMax

integer

groupExpansionMax

integer

items

arrayRequired

timeMax

stringRequired

timeMin

stringRequired

timeZone

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_GET_CALENDAR

Tool Name: Get Google Calendar

Description

Retrieves a specific google calendar, identified by `calendar id`, to which the authenticated user has access.

Action Parameters

calendar_id

stringDefaults to primary

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_PATCH_CALENDAR

Tool Name: Patch Calendar

Description

Partially updates (patches) an existing google calendar, modifying only the fields provided; `summary` is mandatory and cannot be an empty string, and an empty string for `description` or `location` clears them.

Action Parameters

calendar_id

stringRequired

description

string

location

string

summary

stringRequired

timezone

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_PATCH_EVENT

Tool Name: Patch Event

Description

Updates specified fields of an existing event in a google calendar using patch semantics (array fields like `attendees` are fully replaced if provided); ensure the `calendar id` and `event id` are valid and the user has write access to the calendar.

Action Parameters

attendees

array

calendar_id

stringRequired

conference_data_version

integer

description

string

end_time

string

event_id

stringRequired

location

string

max_attendees

integer

rsvp_response

string

send_updates

string

start_time

string

summary

string

supports_attachments

boolean

timezone

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_SYNC_EVENTS

Tool Name: Sync Events

Description

Synchronizes google calendar events, performing a full sync if no `sync token` is provided or if a 410 gone error (due to an expired token) necessitates it, otherwise performs an incremental sync for events changed since the `sync token` was issued.

Action Parameters

calendar_id

stringDefaults to primary

event_types

array

max_results

integer

pageToken

string

single_events

boolean

sync_token

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_UPDATE_EVENT

Tool Name: Update Google event

Description

Updates an existing event by `event id` in a google calendar; this is a full put replacement, so provide all desired fields as unspecified ones may be cleared or reset.

Action Parameters

attendees

array

calendar_id

stringDefaults to primary

create_meeting_room

boolean

description

string

eventType

stringDefaults to default

event_duration_hour

integer

event_duration_minutes

integerDefaults to 30

event_id

stringRequired

guestsCanInviteOthers

boolean

guestsCanSeeOtherGuests

boolean

guests_can_modify

boolean

location

string

recurrence

array

send_updates

boolean

start_datetime

stringRequired

summary

string

timezone

string

transparency

stringDefaults to opaque

visibility

stringDefaults to default

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_GOOGLECALENDAR_CALENDAR_LIST_UPDATE

Tool Name: Update Calendar List Entry

Description

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

Action Parameters

backgroundColor

string

calendar_id

stringRequired

colorId

string

colorRgbFormat

boolean

defaultReminders

array

foregroundColor

string

hidden

boolean

notificationSettings

object

selected

boolean

summaryOverride

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_CLEAR_CALENDAR

Tool Name: Clear Calendar

Description

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

Action Parameters

calendar_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_EVENTS_LIST

Tool Name: List Events

Description

Returns events on the specified calendar.

Action Parameters

alwaysIncludeEmail

boolean

calendarId

stringRequired

eventTypes

string

iCalUID

string

maxAttendees

integer

maxResults

integer

orderBy

string

pageToken

string

privateExtendedProperty

string

sharedExtendedProperty

string

showDeleted

boolean

showHiddenInvitations

boolean

singleEvents

boolean

syncToken

string

timeMax

stringDefaults to 2025-08-21T22:54:29.711543Z

timeMin

stringDefaults to 2025-08-14T22:54:29.711566Z

timeZone

string

updatedMin

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_EVENTS_MOVE

Tool Name: Move Event

Description

Moves an event to another calendar, i.e., changes an event's organizer.

Action Parameters

calendar_id

stringRequired

destination

stringRequired

event_id

stringRequired

send_updates

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_EVENTS_WATCH

Tool Name: Watch Events

Description

Watch for changes to events resources.

Action Parameters

address

stringRequired

calendarId

stringRequired

params

object

payload

boolean

token

string

type

stringDefaults to web_hook

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_FIND_FREE_SLOTS

Tool Name: Find free slots

Description

Finds free/busy time slots in google calendars for specified calendars within a defined time range (defaults to the current day utc if `time min`/`time max` are omitted), enhancing busy intervals with event details; `time min` must precede `time max` if both are provided.

Action Parameters

calendar_expansion_max

integerDefaults to 50

group_expansion_max

integerDefaults to 100

items

arrayDefaults to ['primary']

time_max

string

time_min

string

timezone

stringDefaults to UTC

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_GET_CURRENT_DATE_TIME

Tool Name: Get current date and time

Description

Gets the current date and time, allowing for a specific timezone offset.

Action Parameters

timezone

number

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_GOOGLECALENDAR_CALENDAR_LIST_UPDATE

Tool Name: Update Calendar List Entry

Description

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

Action Parameters

backgroundColor

string

calendar_id

stringRequired

colorId

string

colorRgbFormat

boolean

defaultReminders

array

foregroundColor

string

hidden

boolean

notificationSettings

object

selected

boolean

summaryOverride

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_GOOGLECALENDAR_LIST_CALENDARS

Tool Name: List Google Calendars

Description

Retrieves calendars from the user's google calendar list, with options for pagination and filtering.

Action Parameters

max_results

integerDefaults to 10

min_access_role

string

page_token

string

show_deleted

boolean

show_hidden

boolean

sync_token

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_LIST_ACL_RULES

Tool Name: List ACL Rules

Description

Retrieves the list of access control rules (acls) for a specified calendar, providing the necessary 'rule id' values required for updating specific acl rules.

Action Parameters

calendar_id

stringRequired

max_results

integer

page_token

string

show_deleted

boolean

sync_token

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_GOOGLECALENDAR_LIST_CALENDARS

Tool Name: List Google Calendars

Description

Retrieves calendars from the user's google calendar list, with options for pagination and filtering.

Action Parameters

max_results

integerDefaults to 10

min_access_role

string

page_token

string

show_deleted

boolean

show_hidden

boolean

sync_token

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_QUICK_ADD

Tool Name: Quick Add Event

Description

Parses natural language text to quickly create a basic google calendar event with its title, date, and time, suitable for simple scheduling; does not support direct attendee addition or recurring events, and `calendar id` must be valid if not 'primary'.

Action Parameters

calendar_id

stringDefaults to primary

send_updates

stringDefaults to none

text

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_REMOVE_ATTENDEE

Tool Name: Remove attendee from event

Description

Removes an attendee from a specified event in a google calendar; the calendar and event must exist.

Action Parameters

attendee_email

stringRequired

calendar_id

stringDefaults to primary

event_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_SETTINGS_LIST

Tool Name: List Settings

Description

Returns all user settings for the authenticated user.

Action Parameters

maxResults

integer

pageToken

string

syncToken

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_SETTINGS_WATCH

Tool Name: Watch Settings

Description

Watch for changes to settings resources.

Action Parameters

address

stringRequired

params

object

token

string

type

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

GOOGLECALENDAR_UPDATE_ACL_RULE

Tool Name: Update ACL Rule

Description

Updates an access control rule for the specified calendar.

Action Parameters

calendar_id

stringRequired

role

stringRequired

rule_id

stringRequired

send_notifications

booleanDefaults to True

Action Response

data

objectRequired

error

string

successful

booleanRequired