> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# calendarEvents
> Calendar events on this store, earliest start first unless `orderBy` says otherwise. To list the events overlapping a window, pass its start as `endsAfter` and its end as `startsBefore`. Read `calendarEventCatalog` for what each event type and agenda item kind does.
**Required scopes:** [`calendar_events_read`](/docs/api-reference/v3/reference/scopes#scope-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.
DateTime}>
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`.
CalendarEventSortKey}>
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).
DateTime}>
Only events that start at or before this instant.
CalendarEventType}>
Only events of this type.
## Returns
CalendarEventConnection!} required>
A paginated list of CalendarEvent items.
[CalendarEventEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
CalendarEvent!} required>
The item at this edge.
[CalendarEventAgendaItem!]!} required>
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.
[JSON!]!} required>
`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.
DateTime!} required>
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.
DateTime!} required>
When the event ends. Never before `startAt`.
The id of this calendar event.
DateTime!} required>
When the event starts.
CalendarEventStatus!} required>
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.
CalendarEventType!} required>
The part of the business this event belongs to.
DateTime!} required>
When the event or its agenda was last changed.
[CalendarEvent!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
[CalendarEventAgendaItem!]!} required>
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.
CalendarAgendaItemKind!} required>
What this item adds to the event.
[JSON!]!} required>
`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.
DateTime!} required>
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.
DateTime!} required>
When the event ends. Never before `startAt`.
The id of this calendar event.
DateTime!} required>
When the event starts.
CalendarEventStatus!} required>
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.
CalendarEventType!} required>
The part of the business this event belongs to.
DateTime!} required>
When the event or its agenda was last changed.
PageInfo!} required>
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
```graphql theme={null}
query {
calendarEvents(after: "...", before: "...", endsAfter: "...", first: 10, last: 10, orderBy: CREATED_AT, reverse: true, startsBefore: "...", type: MARKETING) {
nodes {
agendaJson
allDay
createdAt
description
endAt
id
startAt
status
# ...
}
pageInfo { hasNextPage endCursor }
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.