List Event Instances

Returns instances of a recurring event

Usage #

// Import the typed helper
import { listEventInstances } from "@hotglue/sdk/google_calendar";
const result = await client.execute({
...listEventInstances({
calendar_id: string,
event_id: string,
time_min: string,
// ...
}),
userId: "user_123",
});
// result is typed as ListEventInstancesOutput
const result = await client.execute({
integration: "google_calendar",
tool: "list_event_instances",
userId: "user_123",
input: {
calendar_id: string,
event_id: string,
time_min: string,
// ...
},
});
// The agent will automatically use this tool when needed
const agent = new Agent({
tools: () => hotglueTools({
integrations: ["google_calendar"],
userId: "user_123",
}),
});
await agent.generate("run the List Event Instances tool");

Required Permissions #

https://www.googleapis.com/auth/calendar.events.readonly

Input Schema #

calendar_id string required

Calendar identifier

event_id string required

Recurring event identifier

time_min string

Lower bound (inclusive) for event start time (RFC3339)

time_max string

Upper bound (exclusive) for event end time (RFC3339)

max_results int

Maximum number of instances returned

default: 250
page_token string

Token for pagination

This tool calls: #

GET https://www.googleapis.com/calendar/v3/calendars/{calendar_id}/events/{event_id}/instances