Skip to main content

Get All Events

Retrieves all events from a Google Calendar within specified parameters.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Calendar ID - Email address or calendar ID to get events from.
  • Start Time - Lower bound for event start time (RFC3339 format).
  • End Time - Upper bound for event start time (RFC3339 format).
  • Query - Free text search terms to find events.

Options​

  • Credentials - Google Calendar credentials used to authenticate with the service.
  • Max Results - Maximum number of events to return (max 2500). Default is 250.
  • Show Deleted - Whether to include deleted events. Default is false.
  • Single Events - Whether to expand recurring events into individual events. Default is true.
  • Order By - Order of returned events (startTime or updated). Default is startTime.

Output​

  • result - An array of event objects matching the specified criteria.

How It Works​

The Get All Events node integrates with Google Calendar to retrieve events based on specified parameters. When executed, the node:

  1. Authenticates with Google Calendar using the provided credentials
  2. Applies filters based on Calendar ID, time range, and search query
  3. Configures options for maximum results, deleted events, recurring events, and sorting
  4. Retrieves events from Google Calendar
  5. Returns an array of event objects as the result

Requirements​

  • A valid Google Calendar account
  • Valid Google Calendar credentials
  • Properly formatted RFC3339 timestamps for time filters (if provided)
  • Valid Calendar ID (email address or calendar ID)

Error Handling​

The node will return specific errors in the following cases:

  • Invalid time format for Start Time or End Time (must be RFC3339)
  • Invalid value for Max Results (must be between 1 and 2500)
  • Invalid value for Order By (must be 'startTime' or 'updated')
  • Empty or invalid Google Calendar credentials
  • Google Calendar service errors

Usage Notes​

  • The Calendar ID can be an email address or calendar ID. If not provided, the primary calendar is used.
  • Start Time and End Time must be in RFC3339 format (e.g. 2024-03-20T15:30:00Z)
  • The Query parameter allows free text search across event fields
  • Max Results is capped at 2500 events
  • When Show Deleted is false (default), deleted events are not included
  • When Single Events is true (default), recurring events are expanded into individual events
  • Order By determines how results are sorted (by start time or last updated)
  • The result contains an array of event objects with fields like id, summary, description, start, end, attendees, etc.