Required scopes: calendar_events_read
Arguments
Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.
Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.
Only events that end at or after this instant.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
Which key to sort by (defaults to startAt, earliest first). Combine with reverse to flip direction.
Reverses the sort direction selected by orderBy (or its default).
Only events that start at or before this instant.
Only events of this type.
Returns
A paginated list of CalendarEvent items. The list of edges (each a node plus its pagination cursor). Opaque cursor for this item; pass to after/before to page from here.
The item at this edge. The typed items attached to this event, in order. A kind this API version does not model is returned as CalendarUnknownAgendaItem. Change them with agendaOperations on updateCalendarEvent.
agenda with every field selected, as JSON: one element per item, in order, with __typename.
Whether the event spans whole days in timezone rather than specific times.
When the event was created.
Notes about the event. The Commerce Agent reads them for MARKETING events and may repeat them to shoppers, so keep internal notes out.
When the event ends. Never before startAt.
The id of this calendar event.
Whether the event is upcoming, happening now, or ended.
The IANA time zone the event was written in, such as America/New_York. startAt and endAt are instants; this is how to show them.
The name of the event. The Commerce Agent reads it for MARKETING events and may repeat it to shoppers.
The part of the business this event belongs to.
When the event or its agenda was last changed.
The nodes in this page, without the edge/cursor wrapper — a convenience over edges. The typed items attached to this event, in order. A kind this API version does not model is returned as CalendarUnknownAgendaItem. Change them with agendaOperations on updateCalendarEvent. The id of this agenda item. Pass it to an update or remove agenda operation on updateCalendarEvent.
What this item adds to the event.
agenda with every field selected, as JSON: one element per item, in order, with __typename.
Whether the event spans whole days in timezone rather than specific times.
When the event was created.
Notes about the event. The Commerce Agent reads them for MARKETING events and may repeat them to shoppers, so keep internal notes out.
When the event ends. Never before startAt.
The id of this calendar event.
Whether the event is upcoming, happening now, or ended.
The IANA time zone the event was written in, such as America/New_York. startAt and endAt are instants; this is how to show them.
The name of the event. The Commerce Agent reads it for MARKETING events and may repeat it to shoppers.
The part of the business this event belongs to.
When the event or its agenda was last changed.
Pagination metadata for the current page. Cursor of the last edge in this page; pass to after to page forward.
Whether more items exist after this page (drives forward pagination with first/after).
Whether more items exist before this page (drives backward pagination with last/before).
Cursor of the first edge in this page; pass to before to page backward.
Example