Google Calendar: List Events¶
Plugin ID: eca_google_calendar_list_events
Available since: 1.0.0
Lists Google Calendar events with advanced filtering options including date ranges, text search, and status filtering.
Fields¶
Authentication Type— config key:auth_type-
Choose between API Client (OAuth2) or Service Account authentication.
Type:
select· Required: yes · Default:api_clientAllowed values:
api_client,service_account Authentication Source— config key:auth_from-
Choose whether to select authentication directly or use a token for dynamic selection.
Type:
select· Required: yes · Default:directAllowed values:
direct,token API Client— config key:api_client_id-
Search and select an API Client for OAuth2 authentication.
Type:
textfield· Required: no · Default: empty string Service Account— config key:service_account_id-
Search and select a Service Account for server-to-server authentication.
Type:
textfield· Required: no · Default: empty string Client ID from Token— config key:auth_client_from_token-
Token that resolves to a client ID (e.g., [user:field_google_client_id]). The token should contain just the client ID, not the auth type prefix.
This field supports tokens.Type:
textfield· Required: no · Default: empty string Calendar ID— config key:calendar_id-
The calendar ID to use. Leave empty to use primary calendar.
This field supports tokens.Type:
textfield· Required: no · Default:primary Start Time (From)— config key:time_min-
Lower bound for events start time. For date range fields use [entity:field_date_range:start_date], for Smart Date fields use [entity:field_smart_date:value], for regular datetime fields use [entity:field_date:date]. Also supports string formats. Leave empty for no lower bound.
This field supports tokens.Type:
textfield· Required: no · Default: empty string End Time (Until)— config key:time_max-
Upper bound for events start time. For date range fields use [entity:field_date_range:start_date], for Smart Date fields use [entity:field_smart_date:value], for regular datetime fields use [entity:field_date:date]. Also supports string formats. Leave empty for no upper bound.
This field supports tokens.Type:
textfield· Required: no · Default: empty string Search Query— config key:search_query-
Free text search terms to find events whose summaries, descriptions, locations, attendees names or emails contain these terms.
This field supports tokens.Type:
textfield· Required: no · Default: empty string Maximum Results— config key:max_results-
Maximum number of events to return. Maximum value is 2500.
Type:
number· Required: yes · Default:50 Order By— config key:order_by-
The order of the events returned in the result.
Type:
select· Required: yes · Default:startTimeAllowed values:
startTime,updated Expand Recurring Events— config key:single_events-
Whether to expand recurring events into instances and only return single one-off events and instances of recurring events.
Type:
checkbox· Required: no · Default:true Events Token Name— config key:events_token_name-
Token name to store the array of events. Accessible as [token_name:0:event_id], [token_name:1:summary], etc.
This field supports tokens.Type:
textfield· Required: no · Default: empty string Count Token Name— config key:count_token_name-
Token name to store the total number of events found.
This field supports tokens.Type:
textfield· Required: no · Default: empty string