Screens
Available on request only

Screens are individual learning objects within Coassemble. Using the API, you can fetch, create and delete screens.

Get screen types
Available on request only

GET /api/v1/headless/screen/types

Use this endpoint to get all screen types.

Code	Description
default

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

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

Field	Description	Options
`action`	Action to perform	N/A

Field	Type	Description	Required	Default	Pattern
`id`	`integer`	Course ID. If not provided for edit action, will return a URL for a new screen.	Yes	N/A	N/A
`identifier`	`string`	Identifier for your user. In view mode will be used to track progress. In edit mode will be used to track screen creation.	Yes	N/A	N/A
`clientIdentifier`	`string`	Identify a client or group your user may belong to. Useful for multi-tenant situations where you would later like to differentiate between client's screens.	Yes	N/A	N/A

Code	Description
200	Presigned URL to embed

POST /api/v1/headless/screen/{id}

Use this endpoint to create a new screen.

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

Use this endpoint to delete an existing screen.

Field	Description	Options
`id`		N/A

Code	Description
default