arrow_back Embeddables
Collection List Hub 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.
API Endpoint
POST
/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. |
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. |