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.
- You must have
AUTHENTICATED
scope to access calendar events. Anonymous users cannot retrieve calendar data. - The request should contains а valid date(s) boundary for calendar events collection.
- The API user context must be present and valid - otherwise, access is denied.
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 . |
Available CalendarEvents
The API includes an automatic calendar events generation according to next actions:- Scheduled Live session
- Available Live session spots of Live Session Bucket, that relates to started Training
Note: Additional event variations will be made available through the API in future updates.
Examples
Basic Calendar Events Query
Calendar events CTA
Calendar events may include dedicated Call to Action (CTA) objects that define the actions available to the current user, such as registering for a Live Session.TOGGLE_BOOKMARK
that allow users to bookmark/unbookmark events.
Filtering by Event Type
Pagination Example
Related Features
ThegetCalendarEvents
query supports the same advanced features as other catalog queries:
Pagination
Learn how to efficiently navigate through large sets of calendar events using cursor-based pagination.
Authentication
Understand the authentication requirements and how to properly authenticate your requests.
Error Handling
If you don’t provide a
fromDate
parameter, the query will return an error. Always specify a date range for optimal performance.Authentication Errors
Authentication Errors
- 401 Unauthorized: Ensure you’re using a valid authentication token with
AUTHENTICATED
scope - 403 Forbidden: Verify your user account has the necessary permissions to access calendar data
Date Format Errors
Date Format Errors
- Invalid date format: Use ISO 8601 format (e.g., “2025-07-01T00:00:00Z”)
- Invalid date range: Ensure
fromDate
is beforetoDate
- Future dates only: Some implementations may restrict access to events in the distant future
Pagination Errors
Pagination Errors
- Missing cursor parameter: When using
after
, you must also specifyfirst
- Invalid cursor: Ensure cursor values are valid and not expired
- Conflicting parameters: Don’t use both
first
/after
andlast
/before
together
Calendar events are cached for performance. If you don’t see recently added events, wait a few minutes for the cache to refresh, or contact support if the issue persists.