ListEvents
ListEvents
List Google Calendar events using filters (range, keyword, etc.).
yaml
type: "io.kestra.plugin.googleworkspace.calendar.ListEvents"Examples
yaml
id: googleworkspace_calendar_list_events
namespace: company.team
tasks:
- id: list_events
type: io.kestra.plugin.googleworkspace.calendar.ListEvents
serviceAccount: "{{ secret('GCP_SERVICE_ACCOUNT_JSON') }}"
calendarId: primary
timeMin: "2025-08-10T00:00:00Z"
timeMax: "2025-08-12T00:00:00Z"
q: "standup"
singleEvents: true
orderBy: startTime
showDeleted: false
maxResults: 100
Properties
calendarId*Requiredstring
Calendar ID (e.g., 'primary' or a calendar email)
maxResultsintegerstring
Max results (1–2500)
orderBystring
Order by 'startTime' (requires singleEvents=true) or 'updated'
pageTokenstring
Page token for pagination
qstring
Free-text search across title/description/location
readTimeoutintegerstring
Default
120The read timeout for the request (in seconds)
scopesarray
SubTypestring
Default
["https://www.googleapis.com/auth/calendar"]The GCP scopes to used
serviceAccountstring
The GCP service account key
showDeletedbooleanstring
Default
falseInclude cancelled events
singleEventsbooleanstring
Default
trueReturn single instances of recurring events
timeMaxstring
Upper bound for an event's end time (RFC3339)
timeMinstring
Lower bound for an event's start time (RFC3339)
Outputs
eventsarray
Matched events (typed, convenient)
Definitions
io.kestra.plugin.googleworkspace.calendar.models.Event
descriptionstring
idstring
locationstring
statusstring
summarystring
metadataListarray
SubTypeobject
Full Google events (raw metadata, 1: 1)
nextPageTokenstring
Pagination token for fetching the next page, if any
