Documentation is not yet complete.
All requests should be GET
HTTP requests. You must provide your API token in the
format of an Authorization
header like so:
Authorization: Token token=<your api token>
The API endpoints are listed below with the query string parameters that each endpoint supports.
Parameters which are highlighted in yellow are required. Endpoints which are identified as
being paginated also accept the parameters page
(Number) and per_page
(Number).
A paginated list of courses.
Name | Type | Description | Examples |
---|---|---|---|
instructor instructors
|
List (Number) | Filter results by courses that have been taught by particular instructors. Provide a comma separated list of instructor ids. |
|
number numbers
|
List (Number) | Filter results by course number. Provide a comma separated list of numbers. |
|
order |
String |
Set the direction of the sorted results. Must be one of the following:
|
|
query |
String | Filter results by a search query. |
|
sort |
String |
Set how the results are sorted. If provided, it must be one of the following:
|
|
subject subjects
|
List (String) | Filter results by courses belonging/crosslisted to particular subjects. Provide a comma separated list of subject codes. |
|
More detailed information on a course such as its course offerings.
No query string parameters.
A paginated list of subjects.
Name | Type | Description | Examples |
---|---|---|---|
query |
String | Filter results by a search query. |
|
A paginated list of instructors.
Name | Type | Description | Examples |
---|---|---|---|
query |
String | Filter results by a search query. |
|