PluginsPlugin GoogleworkspaceCalendar

ListEvents​List​Events

List Google Calendar events using filters (range, keyword, etc.).

yaml
type: "io.kestra.plugin.googleworkspace.calendar.ListEvents"
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

Calendar ID (e.g., 'primary' or a calendar email)

Max results (1–2500)

Order by 'startTime' (requires singleEvents=true) or 'updated'

Page token for pagination

Free-text search across title/description/location

Default 120

The read timeout for the request (in seconds)

SubType string
Default ["https://www.googleapis.com/auth/calendar"]

The GCP scopes to used

The GCP service account key

Default false

Include cancelled events

Default true

Return single instances of recurring events

Upper bound for an event's end time (RFC3339)

Lower bound for an event's start time (RFC3339)

SubType

Matched events (typed, convenient)

SubType object

Full Google events (raw metadata, 1: 1)

Pagination token for fetching the next page, if any