The Coursepath API has predictable, resource-oriented URLs and we use HTTP response codes to indicate API errors.
All endpoints are at your academy's hostname, under
/api/v1/*. For example the courses in your academy are at:
All API requests must be made over SSL/HTTPS. Calls over plain HTTP will fail.
You always call our API on behalf of one of your users. You don't need to know their password. Instead, you pass a JSON Web Token (JWT) in the “Authorization” request header, using the “Bearer” authentication scheme. For example:
curl -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJqdGkiOjUwODg3MDEzOCwiaWF0IjoxNDMxNDI2NTQxLCJlbWFpbCI6ImpvaG4uc21pdGhAZXhhbXBsZS5jb20ifQ.ChS4fJK5fXT0jYcIVxuJarFBfGP1FkBSE_sk9E4cVuY' https://mycompany.coursepath.com/api/v1/courses
Please read the JWT guide to learn how to generate the JWT token.
Data is returned as JSON, where dates are ISO 8601 formatted. Please check our Formats page for further details.
The API uses conventional HTTP response codes to indicate success or failure of a request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, there was no permission, etc.), and codes in the 5xx range indicate an error with our servers.