List Calendars

Controlled node

Overview

The List Calendars node retrieves all Google Calendars accessible to the authenticated user. This is a discovery node that returns calendar metadata including IDs, names, timezones, and access permissions. Use this node to find calendarId values required by other Google Calendar operations such as creating events, listing events, or updating calendars.

This node requires a valid Google Calendar connection configured in your project connections.

Inputs

Input	Type	Description	Default
Run	Event	Triggers the calendar list retrieval.	-
Max Results	Number	Maximum number of calendars to return (1-250).	100
Show Hidden	Boolean	Whether to include hidden calendars in the results.	false
Min Access Role	Enum	Filter calendars by access level. Options: All (no filter), Free/Busy Reader, Reader, Writer, Owner.	All (no filter)
Connections	Connection	The Google Calendar connection to use for authentication.	-

Outputs

Output	Type	Description
Done	Event	Fires when the calendar list has been successfully retrieved.
Calendars	Data	An array of calendar objects containing id, name, timezone, accessRole, and primary properties. Returns an error object if the operation fails.

Runtime Behavior and Defaults

When triggered, the node calls the Google Calendar API to fetch all calendars accessible to the connected user account.

• Max Results: Defaults to 100 calendars. You can request up to 250 calendars per call.
• Show Hidden: By default, hidden calendars are excluded. Set to true to include calendars that have been hidden from the user's calendar list.
• Min Access Role: By default, all calendars are returned. Use this filter to restrict results based on permission level:
  • freeBusyReader: Only free/busy information is accessible
  • reader: Can view calendar details and events
  • writer: Can modify events
  • owner: Full ownership permissions

The node outputs an array of calendar objects to the Calendars output. Each object contains:

• id: The calendar identifier (used as calendarId in other nodes)
• name: The calendar title
• timezone: The timezone setting for the calendar
• accessRole: Your access level to this calendar
• primary: Boolean indicating if this is the user's primary calendar

If the API call fails (e.g., due to invalid credentials or network issues), the Calendars output will contain an error object with an error property describing the failure.

Example Usage

Connect a Start node or button event to the Run input to trigger the calendar list retrieval. Connect the Calendars output to a Show node to inspect available calendars, or use it with a For Each node to iterate through calendars and perform operations on each one.

[Start] → [List Calendars] → [Show]
                ↓
           [calendars]
                ↓
         [For Each Loop]

Use the id field from the returned calendar objects as the calendarId input for nodes like Create Event, List Events, or Update Event.