Collection List Build and above
The Collection List is a browsable catalogue of multiple collections. Use it when your content is organised into more than one collection of courses and recipients should see the options side by side. The example below pulls in every collection in our demo workspace so you can see how a collection list renders in context.
It's a fit for academies with multiple tracks, partner learning libraries with several distinct journeys, and any setup where the collection (not the individual course) is the primary unit of learning. It gives recipients a directory of programmes to pick from.
Omit clientIdentifier to show every collection in the workspace. Set it to show only that customer's collections.
Give the host <iframe> a descriptive title so recipients can identify the embedded content.
API Endpoint
/v1/headless/embed/collection/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. | |
query.length | number | 100 | Number of items per page (max 100). | |
query.page | number | 0 | Zero-based page index. | |
query.title | string | — | Filter collections by title (case-insensitive contains). | |
query.deleted | boolean | false | Include soft-deleted collections. | |
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. |