Google Workspace ListEvents

Google Workspace ListEvents

Certified

List Google Calendar events with filters

Retrieves events from a shared calendar using time range, keyword, and pagination filters. Defaults: singleEvents true (expands recurring), showDeleted false. orderBy supports startTime (requires singleEvents) or updated; maxResults up to 2500.

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: team@company.com
        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

Email-style calendar shared with the service account, e.g. team@company.com

Max results

Number of events per page (1–2500)

Order by

startTime (requires singleEvents=true) or updated

Page token

Pagination token from a previous response

Reference (ref) of the pluginDefaults to apply to this task.

Keyword search

Free-text query across summary, description, and location

Default120

The read timeout for the request (in seconds)

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

The GCP scopes to used

The GCP service account key

Defaultfalse

Include cancelled

Whether to include cancelled events; default false

Defaulttrue

Return single instances

When true (default), expands recurring events

End time upper bound

RFC3339 timestamp for latest event end (timeMax)

Start time lower bound

RFC3339 timestamp for earliest event start (timeMin)

Matched events

Definitions
descriptionstring
idstring
locationstring
statusstring
summarystring
SubTypeobject

Raw event metadata

Next page token