The Clean Catalog API provides read access to courses, degrees, and text pages. The API must be enabled upon request. Please email [email protected] if you would like the API set up on your site, and please indicate which content types you would like access to.
Each content type has a list endpoint and a detail endpoint. All requests use GET. Successful responses contain JSON.
Use the catalog URL that Clean Catalog provides for your site.
https://YOUR_CATALOG_DOMAIN
Replace YOUR_CATALOG_DOMAIN and YOUR_API_KEY in the examples with your catalog domain and API key provided by Clean Catalog.
Every request requires an API key in the api_key query parameter.
https://YOUR_CATALOG_DOMAIN/api/courses?api_key=YOUR_API_KEY
The same key provides access to courses, degrees, and text pages. A separate catalog login is not required.
The API does not accept the key through an Authorization header.
Keep the API key in your server configuration. Avoid public source code or browser JavaScript that exposes the key.
| Content type | List endpoint | Detail endpoint |
|---|---|---|
| Courses | /api/courses |
/api/courses/{id} |
| Degrees | /api/degrees |
/api/degrees/{id} |
| Text pages | /api/text-pages |
/api/text-pages/{id} |
Keep in mind that the content types may have different labels in your system, but the endpoints remain the same.
Some examples: