Course List Build and above
The Course List is a browsable catalogue of multiple courses. Use it when recipients should be able to discover and choose what to learn without leaving your product. The example below pulls in every course in our demo workspace so you can see how a real catalogue renders in context.
It's a fit for full learning libraries, role-based training menus, customer education hubs, and any "browse all training" experience that belongs inside your product. Where the Course Card highlights one, the Course List opens up the whole catalogue for browsing.
Omit clientIdentifier to show every course in the workspace. Set it to show only that customer's courses.
Give the host <iframe> a descriptive title so recipients can identify the embedded content.
API Endpoint
/v1/headless/embed/course/listBody parameters
| Field | Type | Example | Description | Demo Value |
|---|---|---|---|---|
action | viewedit | view | Determines the target action when a card is clicked. | |
identifier | string | your-user-id | — | — |
clientIdentifier | string | your-tenant-id | — | — |
navigate | nativeeventnone | event | Controls card click behaviour: navigate inside iframe, emit postMessage event, or disable. | |
query.length | number | 100 | Number of items per page (max 100). | |
query.page | number | 0 | Zero-based page index. | |
query.title | string | onboarding | Filter courses by title (case-insensitive contains). | |
query.deleted | boolean | false | Include soft-deleted courses. | |
options.expiresIn | string | 3h | Link opening lifetime, "30s" to "3h" (e.g. "5m"). Invalid values return 400. Course links opened from inside keep 3h. |
Navigation events require the API authoring add-on. With events unavailable, navigate: 'event' opens the item's URL using native navigation. Use navigate: 'none' for a non-interactive card.
Emitted Events
How to listen to events| Type | Event | Description | Notes |
|---|---|---|---|
navigation | open | Fires when a card is clicked with navigate set to "event". | Payload includes url, embeddable, id, and action. |