This article is relevant to users on the Extend and Enterprise plans.
The Coassemble platform provides a REST API that can be used to access and manipulate workspace data.
The API documentation can be viewed at: https://app.coassemble.com/api/doc and is generated automatically to match the current implementation.
Each section of the documentation details routes and methods available for a range of application-specific entities including Courses, Enrolments, Assignments and Reports.
Each route is listed with the corresponding HTTP Method and URL.
eg. the route to GET Courses is listed as:
These rows can be expanded to show the set of parameters for Requests on that route. Parameters may be optional or required, and the data type is shown for each. The set of expected Response codes and data format is also listed.
Try it out
If you have a Coassemble workspace, this documentation is also available at https://[yourworkspace].coassemble.com/api/doc
If you are already logged in to your Coassemble account, you can use the existing browser session to access the documentation; the operations that follow will succeed without requiring authentication keys.
If you are not logged in or intend to test authentication via API key, you'll need to enter your workspace-specific authentication keys via the Authorize button at the top right of the documentation page:
Your Coassemble API Key can be found on the Integrations Settings page in the Advanced tab under Coassemble API, and the Authorization Header value is also shown.
Note that the value used for the 'Try it out' documentation above uses only the substring after 'Authorization:' in the available input.
A couple of important notes:
- API Keys are unique to user account: requests made with a given key will be scoped to the authorisation of that user account.
- API Requests made using the Try It Out method shown here use live workspace data. Requests that perform modifications eg. PATCH, POST etc. will change actual workspace data.
Using the Courses route example from above, clicking the Try it out button in the Parameters section changes the format of that section to allow parameters to be entered for testing:
In this example, all parameters are optional so the Request can be executed without specifying anything further.
Once the Request is sent, the
curl format is shown for convenience*, the full URL used and the Response Code and Response Body and Headers from the server:
curl format can be used as the basis to transform into other formats, methods to do this can easily be found via search engine.
The API documentation page provides baseline information on the available routes on the Coassemble platform and a quick way to test request and response data.
This can be taken further with intended use-cases including: in conjunction with an existing third-party application; via connection to external webhooks or programmed within a custom web application.
We're always keen to hear ways we can improve. Our technical team welcome all feedback on ways we can extend or enhance our platform API. We hope to hear from you soon!