1---
2name: gws-calendar
3description: "Google Calendar: Manage calendars and events."
4metadata:
5  version: 0.22.5
6  openclaw:
7    category: "productivity"
8    requires:
9      bins:
10        - gws
11    cliHelp: "gws calendar --help"
12---
13 
14# calendar (v3)
15 
16> **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.
17 
18```bash
19gws calendar <resource> <method> [flags]
20```
21 
22## Helper Commands
23 
24| Command | Description |
25|---------|-------------|
26| [`+insert`](../gws-calendar-insert/SKILL.md) | create a new event |
27| [`+agenda`](../gws-calendar-agenda/SKILL.md) | Show upcoming events across all calendars |
28 
29## API Resources
30 
31### acl
32 
33  - `delete` — Deletes an access control rule.
34  - `get` — Returns an access control rule.
35  - `insert` — Creates an access control rule.
36  - `list` — Returns the rules in the access control list for the calendar.
37  - `patch` — Updates an access control rule. This method supports patch semantics.
38  - `update` — Updates an access control rule.
39  - `watch` — Watch for changes to ACL resources.
40 
41### calendarList
42 
43  - `delete` — Removes a calendar from the user's calendar list.
44  - `get` — Returns a calendar from the user's calendar list.
45  - `insert` — Inserts an existing calendar into the user's calendar list.
46  - `list` — Returns the calendars on the user's calendar list.
47  - `patch` — Updates an existing calendar on the user's calendar list. This method supports patch semantics.
48  - `update` — Updates an existing calendar on the user's calendar list.
49  - `watch` — Watch for changes to CalendarList resources.
50 
51### calendars
52 
53  - `clear` — Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
54  - `delete` — Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
55  - `get` — Returns metadata for a calendar.
56  - `insert` — Creates a secondary calendar.
57The authenticated user for the request is made the data owner of the new calendar.
58 
59Note: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. Don't use a service account for authentication. If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior.
60  - `patch` — Updates metadata for a calendar. This method supports patch semantics.
61  - `update` — Updates metadata for a calendar.
62 
63### channels
64 
65  - `stop` — Stop watching resources through this channel
66 
67### colors
68 
69  - `get` — Returns the color definitions for calendars and events.
70 
71### events
72 
73  - `delete` — Deletes an event.
74  - `get` — Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.
75  - `import` — Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported.
76Deprecated behavior: If a non-default event is imported, its type will be changed to default and any event-type-specific properties it may have will be dropped.
77  - `insert` — Creates an event.
78  - `instances` — Returns instances of the specified recurring event.
79  - `list` — Returns events on the specified calendar.
80  - `move` — Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved.
81  - `patch` — Updates an event. This method supports patch semantics.
82  - `quickAdd` — Creates an event based on a simple text string.
83  - `update` — Updates an event.
84  - `watch` — Watch for changes to Events resources.
85 
86### freebusy
87 
88  - `query` — Returns free/busy information for a set of calendars.
89 
90### settings
91 
92  - `get` — Returns a single user setting.
93  - `list` — Returns all user settings for the authenticated user.
94  - `watch` — Watch for changes to Settings resources.
95 
96## Discovering Commands
97 
98Before calling any API method, inspect it:
99 
100```bash
101# Browse resources and methods
102gws calendar --help
103 
104# Inspect a method's required params, types, and defaults
105gws schema calendar.<resource>.<method>
106```
107 
108Use `gws schema` output to build your `--params` and `--json` flags.
109 
110