Collections

Collections group courses into curated learning paths. You can list, retrieve, create, update, delete, and restore collections.

info

Collection share traits like identified and private apply to the share link only, not to embeddables. Embeddables get the learner identifier from the embed token, not these flags.

Get collections Build and above

Use this endpoint to get a paginated list of collections.

GET/v1/headless/collections

Query parameters

Field	Type	Required	Default	Options
`identifier`	`string`	No	—	—
`clientIdentifier`	`string`	No	—	—
`length`	`number`	No	`100`	—
`page`	`number`	No	`0`	—
`deleted`	`boolean`	No	`false`	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/api/v1/headless/collections?identifier=user_123&clientIdentifier=client_123&length=100&page=0&deleted=false" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

[
  {
    "id": 1234,
    "clientId": 1234,
    "title": "Workplace Safety",
    "description": "example",
    "key": "abc123",
    "active": false,
    "identifier": "user_123",
    "clientIdentifier": "client_123",
    "paid": false,
    "price": 1,
    "identified": false,
    "private": false,
    "domain": false,
    "themeId": 1234,
    "courses": [
      {
        "id": 1234,
        "title": "Workplace Safety",
        "description": "example",
        "image": "example",
        "imageAltText": "example",
        "imageSource": 1,
        "thumbnail": "example",
        "thumbnailRevision": "example",
        "thumbnailOutdated": false,
        "start": null,
        "timeEstimateMinutes": 1,
        "finish": null,
        "theme": null,
        "clientId": 1234,
        "active": false,
        "identified": false,
        "private": false,
        "paid": false,
        "domain": false,
        "price": 1,
        "key": "abc123",
        "source": "example",
        "identifier": "user_123",
        "clientIdentifier": "client_123",
        "language": "en",
        "revision": "example",
        "collabSeq": 1,
        "published": "2026-10-18T03:30:11.004Z",
        "narrationsGenerated": "2026-10-18T03:30:11.004Z",
        "narrationLanguage": "en",
        "created": "2026-10-18T03:30:11.004Z",
        "updated": "2026-10-18T03:30:11.004Z",
        "type": "example",
        "legacy": false,
        "documentFlow": "example",
        "deleted": "2026-10-18T03:30:11.004Z",
        "folderId": 1234,
        "parentId": 1234,
        "themeId": 1234,
        "draftId": 1234,
        "startScreenId": 1234,
        "finishScreenId": 1234,
        "sequence": 1,
        "screens": [
          {
            "id": 1234,
            "uid": "example",
            "sequence": 1,
            "title": "Workplace Safety",
            "description": "example",
            "asset": "example",
            "assetAltText": "example",
            "assetSource": 1,
            "typeId": 1234,
            "background": null,
            "courseId": 1234,
            "clientId": 1234,
            "sourceId": 1234,
            "scored": false,
            "passingGrade": 1,
            "created": "2026-10-18T03:30:11.004Z",
            "updated": "2026-10-18T03:30:11.004Z",
            "updatedText": "2026-10-18T03:30:11.004Z",
            "narrationsGenerated": "2026-10-18T03:30:11.004Z",
            "aiGenerated": "2026-10-18T03:30:11.004Z",
            "deleted": "2026-10-18T03:30:11.004Z",
            "identifier": "user_123",
            "clientIdentifier": "client_123",
            "quizGroupUid": "example",
            "type": {
              "id": 1234,
              "name": "example",
              "title": "Workplace Safety",
              "icon": "example",
              "sequence": 1,
              "completable": false,
              "created": "2026-10-18T03:30:11.004Z",
              "updated": "2026-10-18T03:30:11.004Z"
            },
            "questions": [
              {
                "id": 1234,
                "screenId": 1234,
                "sequence": 1,
                "text": "example",
                "typeId": 1234,
                "sourceId": 1234,
                "caseSensitive": false,
                "narrationAudioPath": "example",
                "aiGenerated": "2026-10-18T03:30:11.004Z",
                "created": "2026-10-18T03:30:11.004Z",
                "updated": "2026-10-18T03:30:11.004Z",
                "questionType": {
                  "id": 1234,
                  "title": "Workplace Safety",
                  "klass": "example",
                  "template": "example",
                  "created": "2026-10-18T03:30:11.004Z",
                  "updated": "2026-10-18T03:30:11.004Z"
                }
              }
            ],
            "blocks": [
              {
                "id": 1234,
                "screenId": 1234,
                "uid": "example",
                "type": "example",
                "content": "example",
                "column": 1,
                "row": 1,
                "columnSpan": 1,
                "rowSpan": 1,
                "sequence": 1,
                "revision": 1,
                "questionId": 1234,
                "aiGenerated": "2026-10-18T03:30:11.004Z",
                "created": "2026-10-18T03:30:11.004Z",
                "updated": "2026-10-18T03:30:11.004Z",
                "question": {
                  "id": 1234,
                  "screenId": 1234,
                  "sequence": 1,
                  "text": "example",
                  "typeId": 1234,
                  "sourceId": 1234,
                  "caseSensitive": false,
                  "narrationAudioPath": "example",
                  "aiGenerated": "2026-10-18T03:30:11.004Z",
                  "created": "2026-10-18T03:30:11.004Z",
                  "updated": "2026-10-18T03:30:11.004Z",
                  "questionType": {
                    "id": 1234,
                    "title": "Workplace Safety",
                    "klass": "example",
                    "template": "example",
                    "created": "2026-10-18T03:30:11.004Z",
                    "updated": "2026-10-18T03:30:11.004Z"
                  }
                }
              }
            ]
          }
        ],
        "folder": {
          "id": 1234,
          "clientId": 1234,
          "name": "example",
          "colour": "example",
          "created": "2026-10-18T03:30:11.004Z",
          "updated": "2026-10-18T03:30:11.004Z",
          "deleted": "2026-10-18T03:30:11.004Z"
        },
        "courseTheme": {
          "id": 1234,
          "name": "example",
          "logoId": 1234,
          "default": false,
          "logo": {
            "id": 1234,
            "path": "example",
            "name": "example"
          },
          "clientId": 1234,
          "clientIdentifier": "client_123",
          "created": "2026-10-18T03:30:11.004Z",
          "updated": "2026-10-18T03:30:11.004Z"
        },
        "startScreen": {
          "id": 1234,
          "uid": "example",
          "sequence": 1,
          "title": "Workplace Safety",
          "description": "example",
          "asset": "example",
          "assetAltText": "example",
          "assetSource": 1,
          "typeId": 1234,
          "background": null,
          "courseId": 1234,
          "clientId": 1234,
          "sourceId": 1234,
          "scored": false,
          "passingGrade": 1,
          "created": "2026-10-18T03:30:11.004Z",
          "updated": "2026-10-18T03:30:11.004Z",
          "updatedText": "2026-10-18T03:30:11.004Z",
          "narrationsGenerated": "2026-10-18T03:30:11.004Z",
          "aiGenerated": "2026-10-18T03:30:11.004Z",
          "deleted": "2026-10-18T03:30:11.004Z",
          "identifier": "user_123",
          "clientIdentifier": "client_123",
          "quizGroupUid": "example",
          "type": {
            "id": 1234,
            "name": "example",
            "title": "Workplace Safety",
            "icon": "example",
            "sequence": 1,
            "completable": false,
            "created": "2026-10-18T03:30:11.004Z",
            "updated": "2026-10-18T03:30:11.004Z"
          },
          "questions": [
            {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.004Z",
              "created": "2026-10-18T03:30:11.004Z",
              "updated": "2026-10-18T03:30:11.004Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.004Z",
                "updated": "2026-10-18T03:30:11.004Z"
              }
            }
          ],
          "blocks": [
            {
              "id": 1234,
              "screenId": 1234,
              "uid": "example",
              "type": "example",
              "content": "example",
              "column": 1,
              "row": 1,
              "columnSpan": 1,
              "rowSpan": 1,
              "sequence": 1,
              "revision": 1,
              "questionId": 1234,
              "aiGenerated": "2026-10-18T03:30:11.004Z",
              "created": "2026-10-18T03:30:11.004Z",
              "updated": "2026-10-18T03:30:11.004Z",
              "question": {
                "id": 1234,
                "screenId": 1234,
                "sequence": 1,
                "text": "example",
                "typeId": 1234,
                "sourceId": 1234,
                "caseSensitive": false,
                "narrationAudioPath": "example",
                "aiGenerated": "2026-10-18T03:30:11.004Z",
                "created": "2026-10-18T03:30:11.004Z",
                "updated": "2026-10-18T03:30:11.004Z",
                "questionType": {
                  "id": 1234,
                  "title": "Workplace Safety",
                  "klass": "example",
                  "template": "example",
                  "created": "2026-10-18T03:30:11.004Z",
                  "updated": "2026-10-18T03:30:11.004Z"
                }
              }
            }
          ]
        },
        "finishScreen": {
          "id": 1234,
          "uid": "example",
          "sequence": 1,
          "title": "Workplace Safety",
          "description": "example",
          "asset": "example",
          "assetAltText": "example",
          "assetSource": 1,
          "typeId": 1234,
          "background": null,
          "courseId": 1234,
          "clientId": 1234,
          "sourceId": 1234,
          "scored": false,
          "passingGrade": 1,
          "created": "2026-10-18T03:30:11.004Z",
          "updated": "2026-10-18T03:30:11.004Z",
          "updatedText": "2026-10-18T03:30:11.004Z",
          "narrationsGenerated": "2026-10-18T03:30:11.004Z",
          "aiGenerated": "2026-10-18T03:30:11.004Z",
          "deleted": "2026-10-18T03:30:11.004Z",
          "identifier": "user_123",
          "clientIdentifier": "client_123",
          "quizGroupUid": "example",
          "type": {
            "id": 1234,
            "name": "example",
            "title": "Workplace Safety",
            "icon": "example",
            "sequence": 1,
            "completable": false,
            "created": "2026-10-18T03:30:11.004Z",
            "updated": "2026-10-18T03:30:11.004Z"
          },
          "questions": [
            {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.004Z",
              "created": "2026-10-18T03:30:11.004Z",
              "updated": "2026-10-18T03:30:11.004Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.004Z",
                "updated": "2026-10-18T03:30:11.004Z"
              }
            }
          ],
          "blocks": [
            {
              "id": 1234,
              "screenId": 1234,
              "uid": "example",
              "type": "example",
              "content": "example",
              "column": 1,
              "row": 1,
              "columnSpan": 1,
              "rowSpan": 1,
              "sequence": 1,
              "revision": 1,
              "questionId": 1234,
              "aiGenerated": "2026-10-18T03:30:11.005Z",
              "created": "2026-10-18T03:30:11.005Z",
              "updated": "2026-10-18T03:30:11.005Z",
              "question": {
                "id": 1234,
                "screenId": 1234,
                "sequence": 1,
                "text": "example",
                "typeId": 1234,
                "sourceId": 1234,
                "caseSensitive": false,
                "narrationAudioPath": "example",
                "aiGenerated": "2026-10-18T03:30:11.005Z",
                "created": "2026-10-18T03:30:11.005Z",
                "updated": "2026-10-18T03:30:11.005Z",
                "questionType": {
                  "id": 1234,
                  "title": "Workplace Safety",
                  "klass": "example",
                  "template": "example",
                  "created": "2026-10-18T03:30:11.005Z",
                  "updated": "2026-10-18T03:30:11.005Z"
                }
              }
            }
          ]
        },
        "translations": [
          "example"
        ],
        "translationCount": 12
      }
    ],
    "created": "2026-10-18T03:30:11.005Z",
    "updated": "2026-10-18T03:30:11.005Z",
    "deleted": "2026-10-18T03:30:11.005Z"
  }
]

Get collection Build and above

Use this endpoint to get a collection by ID.

GET/v1/headless/collections/{id}

Path parameters

Field	Description	Options
`id`	Collection ID	—

Examples

cURL request

curl --request GET \
  --url "https://api.coassemble.com/api/v1/headless/collections/1234" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

{
  "id": 1234,
  "clientId": 1234,
  "title": "Workplace Safety",
  "description": "example",
  "key": "abc123",
  "active": false,
  "identifier": "user_123",
  "clientIdentifier": "client_123",
  "paid": false,
  "price": 1,
  "identified": false,
  "private": false,
  "domain": false,
  "themeId": 1234,
  "courses": [
    {
      "id": 1234,
      "title": "Workplace Safety",
      "description": "example",
      "image": "example",
      "imageAltText": "example",
      "imageSource": 1,
      "thumbnail": "example",
      "thumbnailRevision": "example",
      "thumbnailOutdated": false,
      "start": null,
      "timeEstimateMinutes": 1,
      "finish": null,
      "theme": null,
      "clientId": 1234,
      "active": false,
      "identified": false,
      "private": false,
      "paid": false,
      "domain": false,
      "price": 1,
      "key": "abc123",
      "source": "example",
      "identifier": "user_123",
      "clientIdentifier": "client_123",
      "language": "en",
      "revision": "example",
      "collabSeq": 1,
      "published": "2026-10-18T03:30:11.005Z",
      "narrationsGenerated": "2026-10-18T03:30:11.005Z",
      "narrationLanguage": "en",
      "created": "2026-10-18T03:30:11.005Z",
      "updated": "2026-10-18T03:30:11.005Z",
      "type": "example",
      "legacy": false,
      "documentFlow": "example",
      "deleted": "2026-10-18T03:30:11.005Z",
      "folderId": 1234,
      "parentId": 1234,
      "themeId": 1234,
      "draftId": 1234,
      "startScreenId": 1234,
      "finishScreenId": 1234,
      "sequence": 1,
      "screens": [
        {
          "id": 1234,
          "uid": "example",
          "sequence": 1,
          "title": "Workplace Safety",
          "description": "example",
          "asset": "example",
          "assetAltText": "example",
          "assetSource": 1,
          "typeId": 1234,
          "background": null,
          "courseId": 1234,
          "clientId": 1234,
          "sourceId": 1234,
          "scored": false,
          "passingGrade": 1,
          "created": "2026-10-18T03:30:11.006Z",
          "updated": "2026-10-18T03:30:11.006Z",
          "updatedText": "2026-10-18T03:30:11.006Z",
          "narrationsGenerated": "2026-10-18T03:30:11.006Z",
          "aiGenerated": "2026-10-18T03:30:11.006Z",
          "deleted": "2026-10-18T03:30:11.006Z",
          "identifier": "user_123",
          "clientIdentifier": "client_123",
          "quizGroupUid": "example",
          "type": {
            "id": 1234,
            "name": "example",
            "title": "Workplace Safety",
            "icon": "example",
            "sequence": 1,
            "completable": false,
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z"
          },
          "questions": [
            {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.006Z",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.006Z",
                "updated": "2026-10-18T03:30:11.006Z"
              }
            }
          ],
          "blocks": [
            {
              "id": 1234,
              "screenId": 1234,
              "uid": "example",
              "type": "example",
              "content": "example",
              "column": 1,
              "row": 1,
              "columnSpan": 1,
              "rowSpan": 1,
              "sequence": 1,
              "revision": 1,
              "questionId": 1234,
              "aiGenerated": "2026-10-18T03:30:11.006Z",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z",
              "question": {
                "id": 1234,
                "screenId": 1234,
                "sequence": 1,
                "text": "example",
                "typeId": 1234,
                "sourceId": 1234,
                "caseSensitive": false,
                "narrationAudioPath": "example",
                "aiGenerated": "2026-10-18T03:30:11.006Z",
                "created": "2026-10-18T03:30:11.006Z",
                "updated": "2026-10-18T03:30:11.006Z",
                "questionType": {
                  "id": 1234,
                  "title": "Workplace Safety",
                  "klass": "example",
                  "template": "example",
                  "created": "2026-10-18T03:30:11.006Z",
                  "updated": "2026-10-18T03:30:11.006Z"
                }
              }
            }
          ]
        }
      ],
      "folder": {
        "id": 1234,
        "clientId": 1234,
        "name": "example",
        "colour": "example",
        "created": "2026-10-18T03:30:11.006Z",
        "updated": "2026-10-18T03:30:11.006Z",
        "deleted": "2026-10-18T03:30:11.006Z"
      },
      "courseTheme": {
        "id": 1234,
        "name": "example",
        "logoId": 1234,
        "default": false,
        "logo": {
          "id": 1234,
          "path": "example",
          "name": "example"
        },
        "clientId": 1234,
        "clientIdentifier": "client_123",
        "created": "2026-10-18T03:30:11.006Z",
        "updated": "2026-10-18T03:30:11.006Z"
      },
      "startScreen": {
        "id": 1234,
        "uid": "example",
        "sequence": 1,
        "title": "Workplace Safety",
        "description": "example",
        "asset": "example",
        "assetAltText": "example",
        "assetSource": 1,
        "typeId": 1234,
        "background": null,
        "courseId": 1234,
        "clientId": 1234,
        "sourceId": 1234,
        "scored": false,
        "passingGrade": 1,
        "created": "2026-10-18T03:30:11.006Z",
        "updated": "2026-10-18T03:30:11.006Z",
        "updatedText": "2026-10-18T03:30:11.006Z",
        "narrationsGenerated": "2026-10-18T03:30:11.006Z",
        "aiGenerated": "2026-10-18T03:30:11.006Z",
        "deleted": "2026-10-18T03:30:11.006Z",
        "identifier": "user_123",
        "clientIdentifier": "client_123",
        "quizGroupUid": "example",
        "type": {
          "id": 1234,
          "name": "example",
          "title": "Workplace Safety",
          "icon": "example",
          "sequence": 1,
          "completable": false,
          "created": "2026-10-18T03:30:11.006Z",
          "updated": "2026-10-18T03:30:11.006Z"
        },
        "questions": [
          {
            "id": 1234,
            "screenId": 1234,
            "sequence": 1,
            "text": "example",
            "typeId": 1234,
            "sourceId": 1234,
            "caseSensitive": false,
            "narrationAudioPath": "example",
            "aiGenerated": "2026-10-18T03:30:11.006Z",
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z",
            "questionType": {
              "id": 1234,
              "title": "Workplace Safety",
              "klass": "example",
              "template": "example",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z"
            }
          }
        ],
        "blocks": [
          {
            "id": 1234,
            "screenId": 1234,
            "uid": "example",
            "type": "example",
            "content": "example",
            "column": 1,
            "row": 1,
            "columnSpan": 1,
            "rowSpan": 1,
            "sequence": 1,
            "revision": 1,
            "questionId": 1234,
            "aiGenerated": "2026-10-18T03:30:11.006Z",
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z",
            "question": {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.006Z",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.006Z",
                "updated": "2026-10-18T03:30:11.006Z"
              }
            }
          }
        ]
      },
      "finishScreen": {
        "id": 1234,
        "uid": "example",
        "sequence": 1,
        "title": "Workplace Safety",
        "description": "example",
        "asset": "example",
        "assetAltText": "example",
        "assetSource": 1,
        "typeId": 1234,
        "background": null,
        "courseId": 1234,
        "clientId": 1234,
        "sourceId": 1234,
        "scored": false,
        "passingGrade": 1,
        "created": "2026-10-18T03:30:11.006Z",
        "updated": "2026-10-18T03:30:11.006Z",
        "updatedText": "2026-10-18T03:30:11.006Z",
        "narrationsGenerated": "2026-10-18T03:30:11.006Z",
        "aiGenerated": "2026-10-18T03:30:11.006Z",
        "deleted": "2026-10-18T03:30:11.006Z",
        "identifier": "user_123",
        "clientIdentifier": "client_123",
        "quizGroupUid": "example",
        "type": {
          "id": 1234,
          "name": "example",
          "title": "Workplace Safety",
          "icon": "example",
          "sequence": 1,
          "completable": false,
          "created": "2026-10-18T03:30:11.006Z",
          "updated": "2026-10-18T03:30:11.006Z"
        },
        "questions": [
          {
            "id": 1234,
            "screenId": 1234,
            "sequence": 1,
            "text": "example",
            "typeId": 1234,
            "sourceId": 1234,
            "caseSensitive": false,
            "narrationAudioPath": "example",
            "aiGenerated": "2026-10-18T03:30:11.006Z",
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z",
            "questionType": {
              "id": 1234,
              "title": "Workplace Safety",
              "klass": "example",
              "template": "example",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z"
            }
          }
        ],
        "blocks": [
          {
            "id": 1234,
            "screenId": 1234,
            "uid": "example",
            "type": "example",
            "content": "example",
            "column": 1,
            "row": 1,
            "columnSpan": 1,
            "rowSpan": 1,
            "sequence": 1,
            "revision": 1,
            "questionId": 1234,
            "aiGenerated": "2026-10-18T03:30:11.006Z",
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z",
            "question": {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.006Z",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.006Z",
                "updated": "2026-10-18T03:30:11.006Z"
              }
            }
          }
        ]
      },
      "translations": [
        "example"
      ],
      "translationCount": 12
    }
  ],
  "created": "2026-10-18T03:30:11.006Z",
  "updated": "2026-10-18T03:30:11.006Z",
  "deleted": "2026-10-18T03:30:11.006Z"
}

Create collection Build and above

Use this endpoint to create a new collection.

Optional share-link gates: identified, private, domain, domains, and emails. These control who can open the collection share link. They do not apply to embeddables.

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	—
`identified`	`boolean`	No	Share-link gate: learners must identify (typically by email) before opening the collection share link. Does not apply to embeddables.	—
`private`	`boolean`	No	Share-link gate: only invited emails can open the collection share link. Does not apply to embeddables.	—
`domain`	`boolean`	No	Share-link gate: only learners on approved email domains can open the collection share link. Does not apply to embeddables.	—
`domains`	`string[]`	No	Share-link gate: approved email domains for the collection share link. Does not apply to embeddables.	—
`emails`	`string[]`	No	Share-link gate: invited learner emails for the collection share link. Does not apply to embeddables.	—

Examples

cURL request

curl --request POST \
  --url "https://api.coassemble.com/api/v1/headless/collection" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "title": "Workplace Safety",
    "description": "example",
    "identifier": "user_123",
    "clientIdentifier": "client_123"
}'

Response

JSON response

{
  "id": 1234,
  "clientId": 1234,
  "title": "Workplace Safety",
  "description": "example",
  "key": "abc123",
  "active": false,
  "identifier": "user_123",
  "clientIdentifier": "client_123",
  "paid": false,
  "price": 1,
  "identified": false,
  "private": false,
  "domain": false,
  "themeId": 1234,
  "courses": [
    {
      "id": 1234,
      "title": "Workplace Safety",
      "description": "example",
      "image": "example",
      "imageAltText": "example",
      "imageSource": 1,
      "thumbnail": "example",
      "thumbnailRevision": "example",
      "thumbnailOutdated": false,
      "start": null,
      "timeEstimateMinutes": 1,
      "finish": null,
      "theme": null,
      "clientId": 1234,
      "active": false,
      "identified": false,
      "private": false,
      "paid": false,
      "domain": false,
      "price": 1,
      "key": "abc123",
      "source": "example",
      "identifier": "user_123",
      "clientIdentifier": "client_123",
      "language": "en",
      "revision": "example",
      "collabSeq": 1,
      "published": "2026-10-18T03:30:11.006Z",
      "narrationsGenerated": "2026-10-18T03:30:11.006Z",
      "narrationLanguage": "en",
      "created": "2026-10-18T03:30:11.006Z",
      "updated": "2026-10-18T03:30:11.006Z",
      "type": "example",
      "legacy": false,
      "documentFlow": "example",
      "deleted": "2026-10-18T03:30:11.006Z",
      "folderId": 1234,
      "parentId": 1234,
      "themeId": 1234,
      "draftId": 1234,
      "startScreenId": 1234,
      "finishScreenId": 1234,
      "sequence": 1,
      "screens": [
        {
          "id": 1234,
          "uid": "example",
          "sequence": 1,
          "title": "Workplace Safety",
          "description": "example",
          "asset": "example",
          "assetAltText": "example",
          "assetSource": 1,
          "typeId": 1234,
          "background": null,
          "courseId": 1234,
          "clientId": 1234,
          "sourceId": 1234,
          "scored": false,
          "passingGrade": 1,
          "created": "2026-10-18T03:30:11.006Z",
          "updated": "2026-10-18T03:30:11.006Z",
          "updatedText": "2026-10-18T03:30:11.006Z",
          "narrationsGenerated": "2026-10-18T03:30:11.006Z",
          "aiGenerated": "2026-10-18T03:30:11.006Z",
          "deleted": "2026-10-18T03:30:11.006Z",
          "identifier": "user_123",
          "clientIdentifier": "client_123",
          "quizGroupUid": "example",
          "type": {
            "id": 1234,
            "name": "example",
            "title": "Workplace Safety",
            "icon": "example",
            "sequence": 1,
            "completable": false,
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z"
          },
          "questions": [
            {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.006Z",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.006Z",
                "updated": "2026-10-18T03:30:11.006Z"
              }
            }
          ],
          "blocks": [
            {
              "id": 1234,
              "screenId": 1234,
              "uid": "example",
              "type": "example",
              "content": "example",
              "column": 1,
              "row": 1,
              "columnSpan": 1,
              "rowSpan": 1,
              "sequence": 1,
              "revision": 1,
              "questionId": 1234,
              "aiGenerated": "2026-10-18T03:30:11.006Z",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z",
              "question": {
                "id": 1234,
                "screenId": 1234,
                "sequence": 1,
                "text": "example",
                "typeId": 1234,
                "sourceId": 1234,
                "caseSensitive": false,
                "narrationAudioPath": "example",
                "aiGenerated": "2026-10-18T03:30:11.006Z",
                "created": "2026-10-18T03:30:11.006Z",
                "updated": "2026-10-18T03:30:11.006Z",
                "questionType": {
                  "id": 1234,
                  "title": "Workplace Safety",
                  "klass": "example",
                  "template": "example",
                  "created": "2026-10-18T03:30:11.006Z",
                  "updated": "2026-10-18T03:30:11.006Z"
                }
              }
            }
          ]
        }
      ],
      "folder": {
        "id": 1234,
        "clientId": 1234,
        "name": "example",
        "colour": "example",
        "created": "2026-10-18T03:30:11.006Z",
        "updated": "2026-10-18T03:30:11.006Z",
        "deleted": "2026-10-18T03:30:11.006Z"
      },
      "courseTheme": {
        "id": 1234,
        "name": "example",
        "logoId": 1234,
        "default": false,
        "logo": {
          "id": 1234,
          "path": "example",
          "name": "example"
        },
        "clientId": 1234,
        "clientIdentifier": "client_123",
        "created": "2026-10-18T03:30:11.006Z",
        "updated": "2026-10-18T03:30:11.006Z"
      },
      "startScreen": {
        "id": 1234,
        "uid": "example",
        "sequence": 1,
        "title": "Workplace Safety",
        "description": "example",
        "asset": "example",
        "assetAltText": "example",
        "assetSource": 1,
        "typeId": 1234,
        "background": null,
        "courseId": 1234,
        "clientId": 1234,
        "sourceId": 1234,
        "scored": false,
        "passingGrade": 1,
        "created": "2026-10-18T03:30:11.006Z",
        "updated": "2026-10-18T03:30:11.006Z",
        "updatedText": "2026-10-18T03:30:11.006Z",
        "narrationsGenerated": "2026-10-18T03:30:11.006Z",
        "aiGenerated": "2026-10-18T03:30:11.006Z",
        "deleted": "2026-10-18T03:30:11.006Z",
        "identifier": "user_123",
        "clientIdentifier": "client_123",
        "quizGroupUid": "example",
        "type": {
          "id": 1234,
          "name": "example",
          "title": "Workplace Safety",
          "icon": "example",
          "sequence": 1,
          "completable": false,
          "created": "2026-10-18T03:30:11.006Z",
          "updated": "2026-10-18T03:30:11.006Z"
        },
        "questions": [
          {
            "id": 1234,
            "screenId": 1234,
            "sequence": 1,
            "text": "example",
            "typeId": 1234,
            "sourceId": 1234,
            "caseSensitive": false,
            "narrationAudioPath": "example",
            "aiGenerated": "2026-10-18T03:30:11.006Z",
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z",
            "questionType": {
              "id": 1234,
              "title": "Workplace Safety",
              "klass": "example",
              "template": "example",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z"
            }
          }
        ],
        "blocks": [
          {
            "id": 1234,
            "screenId": 1234,
            "uid": "example",
            "type": "example",
            "content": "example",
            "column": 1,
            "row": 1,
            "columnSpan": 1,
            "rowSpan": 1,
            "sequence": 1,
            "revision": 1,
            "questionId": 1234,
            "aiGenerated": "2026-10-18T03:30:11.006Z",
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z",
            "question": {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.006Z",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.006Z",
                "updated": "2026-10-18T03:30:11.006Z"
              }
            }
          }
        ]
      },
      "finishScreen": {
        "id": 1234,
        "uid": "example",
        "sequence": 1,
        "title": "Workplace Safety",
        "description": "example",
        "asset": "example",
        "assetAltText": "example",
        "assetSource": 1,
        "typeId": 1234,
        "background": null,
        "courseId": 1234,
        "clientId": 1234,
        "sourceId": 1234,
        "scored": false,
        "passingGrade": 1,
        "created": "2026-10-18T03:30:11.006Z",
        "updated": "2026-10-18T03:30:11.006Z",
        "updatedText": "2026-10-18T03:30:11.006Z",
        "narrationsGenerated": "2026-10-18T03:30:11.006Z",
        "aiGenerated": "2026-10-18T03:30:11.006Z",
        "deleted": "2026-10-18T03:30:11.006Z",
        "identifier": "user_123",
        "clientIdentifier": "client_123",
        "quizGroupUid": "example",
        "type": {
          "id": 1234,
          "name": "example",
          "title": "Workplace Safety",
          "icon": "example",
          "sequence": 1,
          "completable": false,
          "created": "2026-10-18T03:30:11.006Z",
          "updated": "2026-10-18T03:30:11.006Z"
        },
        "questions": [
          {
            "id": 1234,
            "screenId": 1234,
            "sequence": 1,
            "text": "example",
            "typeId": 1234,
            "sourceId": 1234,
            "caseSensitive": false,
            "narrationAudioPath": "example",
            "aiGenerated": "2026-10-18T03:30:11.006Z",
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z",
            "questionType": {
              "id": 1234,
              "title": "Workplace Safety",
              "klass": "example",
              "template": "example",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z"
            }
          }
        ],
        "blocks": [
          {
            "id": 1234,
            "screenId": 1234,
            "uid": "example",
            "type": "example",
            "content": "example",
            "column": 1,
            "row": 1,
            "columnSpan": 1,
            "rowSpan": 1,
            "sequence": 1,
            "revision": 1,
            "questionId": 1234,
            "aiGenerated": "2026-10-18T03:30:11.006Z",
            "created": "2026-10-18T03:30:11.006Z",
            "updated": "2026-10-18T03:30:11.006Z",
            "question": {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.006Z",
              "created": "2026-10-18T03:30:11.006Z",
              "updated": "2026-10-18T03:30:11.006Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.006Z",
                "updated": "2026-10-18T03:30:11.006Z"
              }
            }
          }
        ]
      },
      "translations": [
        "example"
      ],
      "translationCount": 12
    }
  ],
  "created": "2026-10-18T03:30:11.006Z",
  "updated": "2026-10-18T03:30:11.006Z",
  "deleted": "2026-10-18T03:30:11.006Z"
}

Update collection Build and above

Use this endpoint to update an existing collection's metadata and share-link gates.

You can set title, description, identifier, clientIdentifier, themeId, and the share-link gates identified, private, domain, domains, and emails. This endpoint does not change which courses are in the collection.

PUT/v1/headless/collection/{id}

Path parameters

Field	Description	Options
`id`	Collection ID	—

Body parameters

Field	Type	Required	Desc	Options
`title`	`string`	No	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	—
`identified`	`boolean`	No	Share-link gate: learners must identify (typically by email) before opening the collection share link. Does not apply to embeddables.	—
`private`	`boolean`	No	Share-link gate: only invited emails can open the collection share link. Does not apply to embeddables.	—
`domain`	`boolean`	No	Share-link gate: only learners on approved email domains can open the collection share link. Does not apply to embeddables.	—
`domains`	`string[]`	No	Share-link gate: approved email domains for the collection share link. Does not apply to embeddables.	—
`emails`	`string[]`	No	Share-link gate: invited learner emails for the collection share link. Does not apply to embeddables.	—

Examples

cURL request

curl --request PUT \
  --url "https://api.coassemble.com/api/v1/headless/collection/1234" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "title": "Workplace Safety",
    "description": "example",
    "identifier": "user_123",
    "clientIdentifier": "client_123"
}'

Response

JSON response

{
  "id": 1234,
  "clientId": 1234,
  "title": "Workplace Safety",
  "description": "example",
  "key": "abc123",
  "active": false,
  "identifier": "user_123",
  "clientIdentifier": "client_123",
  "paid": false,
  "price": 1,
  "identified": false,
  "private": false,
  "domain": false,
  "themeId": 1234,
  "courses": [
    {
      "id": 1234,
      "title": "Workplace Safety",
      "description": "example",
      "image": "example",
      "imageAltText": "example",
      "imageSource": 1,
      "thumbnail": "example",
      "thumbnailRevision": "example",
      "thumbnailOutdated": false,
      "start": null,
      "timeEstimateMinutes": 1,
      "finish": null,
      "theme": null,
      "clientId": 1234,
      "active": false,
      "identified": false,
      "private": false,
      "paid": false,
      "domain": false,
      "price": 1,
      "key": "abc123",
      "source": "example",
      "identifier": "user_123",
      "clientIdentifier": "client_123",
      "language": "en",
      "revision": "example",
      "collabSeq": 1,
      "published": "2026-10-18T03:30:11.006Z",
      "narrationsGenerated": "2026-10-18T03:30:11.006Z",
      "narrationLanguage": "en",
      "created": "2026-10-18T03:30:11.006Z",
      "updated": "2026-10-18T03:30:11.006Z",
      "type": "example",
      "legacy": false,
      "documentFlow": "example",
      "deleted": "2026-10-18T03:30:11.006Z",
      "folderId": 1234,
      "parentId": 1234,
      "themeId": 1234,
      "draftId": 1234,
      "startScreenId": 1234,
      "finishScreenId": 1234,
      "sequence": 1,
      "screens": [
        {
          "id": 1234,
          "uid": "example",
          "sequence": 1,
          "title": "Workplace Safety",
          "description": "example",
          "asset": "example",
          "assetAltText": "example",
          "assetSource": 1,
          "typeId": 1234,
          "background": null,
          "courseId": 1234,
          "clientId": 1234,
          "sourceId": 1234,
          "scored": false,
          "passingGrade": 1,
          "created": "2026-10-18T03:30:11.006Z",
          "updated": "2026-10-18T03:30:11.006Z",
          "updatedText": "2026-10-18T03:30:11.006Z",
          "narrationsGenerated": "2026-10-18T03:30:11.007Z",
          "aiGenerated": "2026-10-18T03:30:11.007Z",
          "deleted": "2026-10-18T03:30:11.007Z",
          "identifier": "user_123",
          "clientIdentifier": "client_123",
          "quizGroupUid": "example",
          "type": {
            "id": 1234,
            "name": "example",
            "title": "Workplace Safety",
            "icon": "example",
            "sequence": 1,
            "completable": false,
            "created": "2026-10-18T03:30:11.007Z",
            "updated": "2026-10-18T03:30:11.007Z"
          },
          "questions": [
            {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.007Z",
              "created": "2026-10-18T03:30:11.007Z",
              "updated": "2026-10-18T03:30:11.007Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.007Z",
                "updated": "2026-10-18T03:30:11.007Z"
              }
            }
          ],
          "blocks": [
            {
              "id": 1234,
              "screenId": 1234,
              "uid": "example",
              "type": "example",
              "content": "example",
              "column": 1,
              "row": 1,
              "columnSpan": 1,
              "rowSpan": 1,
              "sequence": 1,
              "revision": 1,
              "questionId": 1234,
              "aiGenerated": "2026-10-18T03:30:11.007Z",
              "created": "2026-10-18T03:30:11.007Z",
              "updated": "2026-10-18T03:30:11.007Z",
              "question": {
                "id": 1234,
                "screenId": 1234,
                "sequence": 1,
                "text": "example",
                "typeId": 1234,
                "sourceId": 1234,
                "caseSensitive": false,
                "narrationAudioPath": "example",
                "aiGenerated": "2026-10-18T03:30:11.007Z",
                "created": "2026-10-18T03:30:11.007Z",
                "updated": "2026-10-18T03:30:11.007Z",
                "questionType": {
                  "id": 1234,
                  "title": "Workplace Safety",
                  "klass": "example",
                  "template": "example",
                  "created": "2026-10-18T03:30:11.007Z",
                  "updated": "2026-10-18T03:30:11.007Z"
                }
              }
            }
          ]
        }
      ],
      "folder": {
        "id": 1234,
        "clientId": 1234,
        "name": "example",
        "colour": "example",
        "created": "2026-10-18T03:30:11.007Z",
        "updated": "2026-10-18T03:30:11.007Z",
        "deleted": "2026-10-18T03:30:11.007Z"
      },
      "courseTheme": {
        "id": 1234,
        "name": "example",
        "logoId": 1234,
        "default": false,
        "logo": {
          "id": 1234,
          "path": "example",
          "name": "example"
        },
        "clientId": 1234,
        "clientIdentifier": "client_123",
        "created": "2026-10-18T03:30:11.007Z",
        "updated": "2026-10-18T03:30:11.007Z"
      },
      "startScreen": {
        "id": 1234,
        "uid": "example",
        "sequence": 1,
        "title": "Workplace Safety",
        "description": "example",
        "asset": "example",
        "assetAltText": "example",
        "assetSource": 1,
        "typeId": 1234,
        "background": null,
        "courseId": 1234,
        "clientId": 1234,
        "sourceId": 1234,
        "scored": false,
        "passingGrade": 1,
        "created": "2026-10-18T03:30:11.007Z",
        "updated": "2026-10-18T03:30:11.007Z",
        "updatedText": "2026-10-18T03:30:11.007Z",
        "narrationsGenerated": "2026-10-18T03:30:11.007Z",
        "aiGenerated": "2026-10-18T03:30:11.007Z",
        "deleted": "2026-10-18T03:30:11.007Z",
        "identifier": "user_123",
        "clientIdentifier": "client_123",
        "quizGroupUid": "example",
        "type": {
          "id": 1234,
          "name": "example",
          "title": "Workplace Safety",
          "icon": "example",
          "sequence": 1,
          "completable": false,
          "created": "2026-10-18T03:30:11.007Z",
          "updated": "2026-10-18T03:30:11.007Z"
        },
        "questions": [
          {
            "id": 1234,
            "screenId": 1234,
            "sequence": 1,
            "text": "example",
            "typeId": 1234,
            "sourceId": 1234,
            "caseSensitive": false,
            "narrationAudioPath": "example",
            "aiGenerated": "2026-10-18T03:30:11.007Z",
            "created": "2026-10-18T03:30:11.007Z",
            "updated": "2026-10-18T03:30:11.007Z",
            "questionType": {
              "id": 1234,
              "title": "Workplace Safety",
              "klass": "example",
              "template": "example",
              "created": "2026-10-18T03:30:11.007Z",
              "updated": "2026-10-18T03:30:11.007Z"
            }
          }
        ],
        "blocks": [
          {
            "id": 1234,
            "screenId": 1234,
            "uid": "example",
            "type": "example",
            "content": "example",
            "column": 1,
            "row": 1,
            "columnSpan": 1,
            "rowSpan": 1,
            "sequence": 1,
            "revision": 1,
            "questionId": 1234,
            "aiGenerated": "2026-10-18T03:30:11.007Z",
            "created": "2026-10-18T03:30:11.007Z",
            "updated": "2026-10-18T03:30:11.007Z",
            "question": {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.007Z",
              "created": "2026-10-18T03:30:11.007Z",
              "updated": "2026-10-18T03:30:11.007Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.007Z",
                "updated": "2026-10-18T03:30:11.007Z"
              }
            }
          }
        ]
      },
      "finishScreen": {
        "id": 1234,
        "uid": "example",
        "sequence": 1,
        "title": "Workplace Safety",
        "description": "example",
        "asset": "example",
        "assetAltText": "example",
        "assetSource": 1,
        "typeId": 1234,
        "background": null,
        "courseId": 1234,
        "clientId": 1234,
        "sourceId": 1234,
        "scored": false,
        "passingGrade": 1,
        "created": "2026-10-18T03:30:11.007Z",
        "updated": "2026-10-18T03:30:11.007Z",
        "updatedText": "2026-10-18T03:30:11.007Z",
        "narrationsGenerated": "2026-10-18T03:30:11.007Z",
        "aiGenerated": "2026-10-18T03:30:11.007Z",
        "deleted": "2026-10-18T03:30:11.007Z",
        "identifier": "user_123",
        "clientIdentifier": "client_123",
        "quizGroupUid": "example",
        "type": {
          "id": 1234,
          "name": "example",
          "title": "Workplace Safety",
          "icon": "example",
          "sequence": 1,
          "completable": false,
          "created": "2026-10-18T03:30:11.007Z",
          "updated": "2026-10-18T03:30:11.007Z"
        },
        "questions": [
          {
            "id": 1234,
            "screenId": 1234,
            "sequence": 1,
            "text": "example",
            "typeId": 1234,
            "sourceId": 1234,
            "caseSensitive": false,
            "narrationAudioPath": "example",
            "aiGenerated": "2026-10-18T03:30:11.007Z",
            "created": "2026-10-18T03:30:11.007Z",
            "updated": "2026-10-18T03:30:11.007Z",
            "questionType": {
              "id": 1234,
              "title": "Workplace Safety",
              "klass": "example",
              "template": "example",
              "created": "2026-10-18T03:30:11.007Z",
              "updated": "2026-10-18T03:30:11.007Z"
            }
          }
        ],
        "blocks": [
          {
            "id": 1234,
            "screenId": 1234,
            "uid": "example",
            "type": "example",
            "content": "example",
            "column": 1,
            "row": 1,
            "columnSpan": 1,
            "rowSpan": 1,
            "sequence": 1,
            "revision": 1,
            "questionId": 1234,
            "aiGenerated": "2026-10-18T03:30:11.007Z",
            "created": "2026-10-18T03:30:11.007Z",
            "updated": "2026-10-18T03:30:11.007Z",
            "question": {
              "id": 1234,
              "screenId": 1234,
              "sequence": 1,
              "text": "example",
              "typeId": 1234,
              "sourceId": 1234,
              "caseSensitive": false,
              "narrationAudioPath": "example",
              "aiGenerated": "2026-10-18T03:30:11.007Z",
              "created": "2026-10-18T03:30:11.007Z",
              "updated": "2026-10-18T03:30:11.007Z",
              "questionType": {
                "id": 1234,
                "title": "Workplace Safety",
                "klass": "example",
                "template": "example",
                "created": "2026-10-18T03:30:11.007Z",
                "updated": "2026-10-18T03:30:11.007Z"
              }
            }
          }
        ]
      },
      "translations": [
        "example"
      ],
      "translationCount": 12
    }
  ],
  "created": "2026-10-18T03:30:11.008Z",
  "updated": "2026-10-18T03:30:11.008Z",
  "deleted": "2026-10-18T03:30:11.008Z"
}

Delete collection Build 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	—

Examples

cURL request

curl --request DELETE \
  --url "https://api.coassemble.com/api/v1/headless/collection/1234" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

false

Restore collection Build 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	—

Examples

cURL request

curl --request POST \
  --url "https://api.coassemble.com/api/v1/headless/collection/1234/restore" \
  --header "Authorization: COASSEMBLE:YOUR_WORKSPACE_ID:YOUR_API_KEY"

Response

JSON response

false