Courses

Get course information

get

This endpoint will return the course collection information.

Authorizations
Path parameters
course_idintegerRequired

ID of the course to get the details of.

Responses
200
After a successful request, the endpoint returns HTTP 200.
application/json
get
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-06-27T08:36:31.577Z",
    "course_id": 1
  }
}

Get a list of perspectives of a course

get

This endpoint will return all the perspectives in a course.

Authorizations
Path parameters
course_idintegerRequired

ID of the course to retrieve perspectives from

Responses
200
After a successful request, the endpoint returns HTTP 200.
application/json
get
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-06-27T08:36:31.577Z",
      "media": {
        "id": 1,
        "title": "text",
        "description": "text",
        "duration": 1,
        "created_at": "2025-06-27T08:36:31.577Z",
        "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"
      }
    }
  ]
}

Last updated

Was this helpful?