Login

Courses

Courses are learning objects within Coassemble. Using the API, you can fetch and delete courses as well as get a signed URL for courses for embedding.

Endpoints

Get courses

GET /api/v1/headless/courses

Use this endpoint to get all your courses.

Query parameters

FieldTypeDescriptionRequiredDefaultPattern
pageintegerWhich page of items to display, starting with zeroNo N/A N/A
lengthintegerItems per page (0-100)No N/A N/A
identifierstringSearch for courses created by identifierNo N/A N/A
clientIdentifierstringSearch for courses created by client identifierNo N/A N/A

Responses

CodeDescription
200Your courses
401You are not authorized to access this resource

Get a signed URL for a course

GET /api/v1/headless/course/{action}

Use this endpoint to get a signed URL for a course. This URL can be used to embed the Coassemble interface into your application within an iframe.

Note that the edit action is only available to workspaces that have access to Headless course creation.

Path parameters

FieldDescriptionOptions
actionAction to performview  edit 

Query parameters

FieldTypeDescriptionRequiredDefaultPattern
idintegerCourse IDNo N/A N/A
identifierstringIdentifier for your user. In `view` mode will be used to track progress. In `edit` mode will be used to track course creation.Yes N/A N/A
clientIdentifierstringIdentify a client or group your user may belong to. Useful for multi-tenant situations where you would later like to differentiate between client's courses.No N/A N/A

Responses

CodeDescription
200Presigned URL to embed

Delete course

DELETE /api/v1/headless/courses/{id}

Use this endpoint to delete an existing course.

Path parameters

FieldDescriptionOptions
idCourse ID N/A

Responses

CodeDescription
200Course deleted