View as Markdown
Google Calendar icon

Google Calendar ACTION

List Event Instances

Retrieve instances of a recurring event. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Calendar account once, then configure and run List Event Instances from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "google_calendar-list-event-instances",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_calendar: { authProvisionId: "apn_xxxxxxx" },
    calendarId: "Calendar",
    eventId: "Event",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Event Instances inputs
Property Type Description
calendarId Calendar string
Optionally select the calendar, defaults to the primary calendar for the logged-in user
Optional Dynamic
eventId Event string
The recurring event identifier. Select an event from Google Calendar.
Required Dynamic
maxAttendees Max Attendees integer
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
Optional
maxResults Max Results integer
Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
Optional
showDeleted Show Deleted boolean
Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.
Optional
timeMax Max Time string
Upper bound (exclusive) for an event's time to filter by. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. Must be greater than Min Time.
Optional
timeMin Min time string
Lower bound (exclusive) for an event's time to filter by. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. Must be smaller than Max Time.
Optional
timeZone Time Zone string
Time zone used in the response. Optional. The default is the time zone of the calendar.
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
google_calendar-list-event-instances
Version
0.0.5
App
Google Calendar
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes