Skip to main content

Our detailed OpenAPI documentation defines all endpoints, parameters, schemas, and responses. The documentation also provides descriptions for all object properties. Example requests and responses are also provided.

Unrestricted admin can access API v3 documentation through the API v3 tab found on the account Settings page - as seen below:

Access the detailed OpenAPI documentation through the API v3 tab in you account Settings

Detailed OpenAPI documentation can also be accessed in HTML or JSON format - on the server to which you make API requests. Simply append your account URL with the following extensions:

HTML/human readable format:

Using API v3 with Versioning

For accounts with Versioning enabled, courses are supported in API v3 as detailed in the graphic below. Course content updates should be made to the Draft version of a course. Other necessary updates should be made to the Published version of a course.