List events
The List events action to retrieve calendar events from a specific Google Calendar. This is a read-only action that supports filters such as time range, event types, search terms, and extended properties.
Prerequisites
- Ensure a connected Google Calendar account exists for the user.
- The connected account must have permission in Google Calendar to add events.
- Google Calendar must be connected as a data source for Glean actions.
Supported parameters
| Parameter | Type | Description |
|---|---|---|
| Calendar ID | String | Calendar identifier. Use "primary" for the user's main calendar or a specific calendar ID for shared calendars. |
| Time min | String | Lower bound (exclusive) for an event's end time to filter by. Must be an RFC3339 timestamp with time zone offset (e.g., 2011-06-03T10:00:00-07:00). |
| Time max | String | Upper bound (exclusive) for an event's start time to filter by. Must be an RFC3339 timestamp with time zone offset. Must be greater than timeMin if both are set. |
| Event types | Array | Event types to return. Acceptable values: birthday, default, focusTime, fromGmail, outOfOffice, workingLocation. Can be repeated for multiple types. |
| Single events | Boolean | Whether to expand recurring events into instances. Default is false. |
| Order by | String | Order of events in results. Acceptable values: startTime, updated. Default is unspecified stable order. |
| Max results | Integer | Maximum number of events per page. Default is 250, maximum is 2,500. |
| Page token | String | Token specifying which result page to return for pagination. |
| Show deleted | Boolean | Whether to include deleted events (cancelled status). Default is false. |
| Show hidden invitations | Boolean | Whether to include hidden invitations. Default is false. |
| Time zone | String | Time zone used in the response. Default is the user's primary time zone. |
| q | String | Free text search terms to find events matching these terms in various fields. |
| iCal UID | String | Event ID in iCalendar format to search for a specific event. |
| Max attendees | Integer | Maximum number of attendees to include in the response. |
| Sync token | String | Token from previous list request's nextSyncToken to retrieve only changed entries. |
| Updated min | String | Lower bound for event's last modification time (RFC3339 timestamp) to filter by. |
| Private extended property | String | Extended properties constraint as propertyName=value. Matches only private properties. |
| Shared extended property | String | Extended properties constraint as propertyName=value. Matches only shared properties. |
Usage examples
-
"Show me all my meetings this week."
-
"List all events on my calendar for tomorrow."
-
"What events do I have next Monday?"