List events

googleCalendar.listEvents returns one Google page with page and sync tokens. Use it for explicit pagination or to maintain a sync cursor.

Example

import { automation, onDashboardRun } from "automate.ax"
import { googleCalendar } from "automate.ax/google-calendar"

export default automation("List this week's events", () => {
  onDashboardRun({ title: "List this week's events" })

  googleCalendar.listEvents({
    calendar: "Team Calendar",
    timeMin: "2026-08-10T00:00:00-07:00",
    timeMax: "2026-08-17T00:00:00-07:00",
    singleEvents: true,
    maxResults: 250,
  })
})

Inputs

Property	Type	Required	Description
`calendar`	`string`	No	Exact title or ID. Defaults to primary.
`maxResults`	`number`	No	Page size from 1 to 2,500.
`pageToken`	`string`	No	`nextPageToken` from the previous page.
`query`	`string`	No	Google’s free-text event search.
`iCalUID`	`string`	No	Match one cross-calendar iCalendar UID.
`timeMin`, `timeMax`, `updatedMin`	`string`	No	Exclusive event-end lower bound, exclusive event-start upper bound, and minimum update time in `RFC 3339` format.
`singleEvents`	`boolean`	No	Expand recurring series into instances.
`orderBy`	`"startTime" \| "updated"`	No	Sort by start time or last update. `"startTime"` requires `singleEvents: true`; expanded events without `syncToken` default to start-time order.
`includeDeleted`	`boolean`	No	Include cancelled/deleted representations.
`includeHiddenInvitations`	`boolean`	No	Include invitations hidden from the connected user’s calendar.
`eventTypes`	`("birthday" \| "default" \| "focusTime" \| "fromGmail" \| "outOfOffice" \| "workingLocation")[]`	No	Event types to include.
`maxAttendees`	`number`	No	Maximum attendees returned per event.
`privateExtendedProperty`, `sharedExtendedProperty`	`string[]`	No	`name=value` extended-property filters.
`syncToken`	`string`	No	Token from a completed earlier listing.
`timeZone`	`string`	No	`IANA` response timezone.
Second argument: `{ account }`	Google Account reference	No	Connected account. Defaults to the project binding.

Output

Returns { events: CalendarEvent[]; nextPageToken?: string; nextSyncToken?: string; timeZone?: string; updatedAt?: string }. See Get event for each event. Follow nextPageToken until absent. Only then persist nextSyncToken. Automate.ax rejects filters that Google doesn’t allow with syncToken. An expired token causes the provider request to fail so you can perform a full resync.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output