Retrieve calendar events for authenticated users with date range filtering, pagination, and sorting capabilities
getCalendarEvents
query allows you to retrieve calendar events for authenticated users. This endpoint returns both user-specific personal events and publicly accessible events that are visible to all authenticated (non-anonymous) users.
AUTHENTICATED
scope to access calendar events. Anonymous users cannot retrieve calendar data.Argument | Type | Description |
---|---|---|
fromDate | DateTime | Required. The beginning boundary of calendar events date range. Date should be compliant to ISO 8601. |
toDate | DateTime | The ending boundary of calendar events date range. Date should be compliant to ISO 8601. |
type | CalendarEventType | Returns results that come after the specified cursor. Should be used together with first parameter. Cannot be used if before is set. |
after | Cursor | Returns the elements that come before the specified cursor. |
before | Cursor | Returns results that come before the specified cursor. Should be used together with last parameter. Cannot be used if after is set. |
first | Integer | Returns up to the first N elements from the list. Required if after parameter is set. Cannot be used together with last . |
last | Integer | Returns up to the first N elements from the list. Required if before parameter is set. Cannot be used together with first . |
getCalendarEvents
query supports the same advanced features as other catalog queries:
fromDate
parameter, the query will return an error. Always specify a date range for optimal performance.Authentication Errors
AUTHENTICATED
scopeDate Format Errors
fromDate
is before toDate
Pagination Errors
after
, you must also specify first
first
/after
and last
/before
together