Docs
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/list

Body parameters

FieldTypeExampleDescriptionDemo Value
actionvieweditviewDetermines the target action when a card is clicked.
identifierstringyour-user-id
clientIdentifierstringyour-tenant-id
navigatenativeeventnoneeventControls card click behaviour.
query.lengthnumber100Number of items per page (max 100).
query.pagenumber0Zero-based page index.
query.titlestringFilter collections by title (case-insensitive contains).
query.deletedbooleanfalseInclude soft-deleted collections.
TypeEventDescriptionNotes
navigationopenFires when a card is clicked with navigate set to "event".Payload includes url, embeddable, id, and action.

Live Demo