Supported Entity Types
The bookmark system supports the following entity types:Learning Paths
Bookmark learning paths for easy access to ongoing or planned education.
Calendar Events
Save important events to your personal bookmark collection.
Authentication Requirements
The API user context should be associated with the AUTHENTICATED scope in order to access the bookmark functionality.
Available Operations
The bookmark API provides two main operations:Toggle Bookmark
Add or remove bookmarks for learning paths and calendar events
Bookmarked Calendar Events
Query bookmarked calendar events with advanced filtering and pagination
Integration Features
Call to Action (CTA) Integration
The bookmark system automatically integrates with the CTA system to provide interactive bookmark buttons in catalog and entity interfaces. Bookmark CTAs are automatically generated for learning paths and calendar events with action IDTOGGLE_BOOKMARK. The button labels dynamically change between “Add to bookmarks” and “Remove from bookmarks” based on the current bookmark status.
Learning Path CTA
See how bookmark CTAs are integrated with learning path actions
Catalog Filtering
The bookmark system extends the standard Filtering Catalog Items functionality with a specialized bookmark filter (filter_bookmark) that allows authenticated users to filter catalog results to show only bookmarked learning paths.
Data Structure
Bookmark Object
Each bookmark contains the following information:| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier for the bookmark record |
entityId | ID! | The ID of the entity that is bookmarked (learning path or calendar event) |
entityType | BookmarkableEntityType! | The type of entity bookmarked. Can be LEARNING_PATH or EVENT |
BookmarkableEntityType Enum
| Value | Type | Description |
|---|---|---|
LEARNING_PATH | Enum | Represents a learning path entity that can be bookmarked |
EVENT | Enum | Represents a calendar event entity that can be bookmarked |