Collections
Collections group courses into curated learning paths. You can list, retrieve, create, delete, and restore collections.
Get collections Hub and above
Use this endpoint to get a paginated list of collections.
GET/v1/headless/collections
Query parameters
| Field | Type | Required | Default | Description | Options |
|---|
identifier | string | No | — | | — |
clientIdentifier | string | No | — | | — |
length | number | No | 100 | | — |
page | number | No | 0 | | — |
deleted | boolean | No | false | | — |
Get collection Hub and above
Use this endpoint to get a collection by ID.
GET/v1/headless/collections/{id}
Path parameters
| Field | Description | Options |
|---|
id | Collection ID | — |
Create collection Embed Core and above
Use this endpoint to create a new collection.
POST/v1/headless/collection
Body parameters
| Field | Type | Required | Desc | Options |
|---|
title | string | Yes | Title shown to learners | — |
description | string | null | No | Description shown on the collection landing screen | — |
identifier | string | No | Your stable identifier for the collection owner | — |
clientIdentifier | string | No | The client this collection belongs to | — |
themeId | number | null | No | Theme ID applied to the collection | — |
courseIds | number[] | No | Initial course IDs to include, in display order | — |
Delete collection Embed Core and above
Use this endpoint to soft-delete a collection by ID.
DELETE/v1/headless/collection/{id}
Path parameters
| Field | Description | Options |
|---|
id | Collection ID | — |
Restore collection Embed Core and above
Use this endpoint to restore a soft-deleted collection.
POST/v1/headless/collection/{id}/restore
Path parameters
| Field | Description | Options |
|---|
id | Collection ID | — |