Courses
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
This endpoint will return the course collection information.
ID of the course to get the details of.
After a successful request, the endpoint returns HTTP 200.
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
If course is not found with the provided id, the endpoint returns HTTP 404.
Invalid parameters.
GET /api/public/v1/courses/{course_id} HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"course": {
"id": 1,
"name": "text",
"type": "text",
"permission": "text",
"owner": {
"id": 1,
"full_name": "text",
"display_name": "text",
"email": "text"
},
"created_at": "2025-08-25T16:50:28.336Z",
"course_id": 1
}
}
This endpoint will return all the perspectives in a course.
ID of the course to retrieve perspectives from
After a successful request, the endpoint returns HTTP 200.
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
If course is not found with the provided id, the endpoint returns HTTP 404.
Invalid parameters.
GET /api/public/v1/courses/{course_id}/perspectives HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"perspectives": [
{
"uuid": "text",
"title": "text",
"description": "text",
"duration": 1,
"created_at": "2025-08-25T16:50:28.336Z",
"media": {
"id": 1,
"title": "text",
"description": "text",
"duration": 1,
"created_at": "2025-08-25T16:50:28.336Z",
"last_viewed": "2025-08-25",
"last_viewed_by_student": "2025-08-25",
"thumbnail_url": "text",
"transcoding_status": "text",
"owner": {
"id": 1,
"full_name": "text",
"display_name": "text",
"email": "text"
},
"size": 1,
"source": "text",
"embed_id": "text",
"lti_launch_id": "text"
}
}
]
}