Google: Returns instances of the specified recurring event

← calendar_events operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation google.calendar_events_instances

Provider route: GET /calendar/v3/calendars/{calendarId}/events/{eventId}/instances. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["calendarEvents"]["calendarEventsInstances"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.calendarEvents.calendarEventsInstances(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.calendar_events.calendar_events_instances(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.calendarId	string	Required within parent	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the “primary” keyword.
path.eventId	string	Required within parent	Recurring event identifier.
query	object	Optional	Additional keys: not allowed
query.fields	string	Optional	Selector specifying which fields to include in a partial response.
query.prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
query.quotaUser	string	Optional	An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
query.userIp	string	Optional	Deprecated. Please use quotaUser instead.
query.alwaysIncludeEmail	boolean	Optional	Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
query.maxAttendees	integer	Optional	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. Format: int32 Minimum: 1
query.maxResults	integer	Optional	Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. Format: int32 Minimum: 1
query.originalStart	string	Optional	The original start time of the instance in the result. Optional.
query.pageToken	string	Optional	Token specifying which result page to return. Optional.
query.showDeleted	boolean	Optional	Whether to include deleted events (with status equals “cancelled”) in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.
query.timeMax	string	Optional	Upper bound (exclusive) for an event’s start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset. Format: date-time
query.timeMin	string	Optional	Lower bound (inclusive) for an event’s end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset. Format: date-time
query.timeZone	string	Optional	Time zone used in the response. Optional. The default is the time zone of the calendar.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Returns events on the specified calendar — response body

Referenced models: Returns events on the specified calendar — response body

Policy, approvals and errors

SDK function policy ID: google.calendar_events_instances. Catalog operation: calendar.events.instances. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.app.created", "https://www.googleapis.com/auth/calendar.events", "https://www.googleapis.com/auth/calendar.events.freebusy", "https://www.googleapis.com/auth/calendar.events.owned", "https://www.googleapis.com/auth/calendar.events.owned.readonly", "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly"]

Official provider source