Reviews

Update or Create a Review

put

https://lor.instructure.comhttps://lor-beta.instructure.comhttps://commons.eu-central.canvaslms.comhttps://commons-fra-beta.instructure.comhttps://commons.ca-central.canvaslms.comhttps://commons-yul-beta.instructure.comhttps://commons.sydney.canvaslms.comhttps://commons-syd-beta.instructure.comhttps://commons.singapore.canvaslms.comhttps://commons-sin-beta.instructure.com

/api/resources/{resourceId}/reviews/self

Create or update a user's review for a resource. You cannot create multiple reviews for a single user on a resource. If a user tries to create a second review on a resource it will just update their first review. You must provide a textual review, rating, or both. A 200 status code is returned upon a successful update and a 201 status code is returned on successful creation.

Example:

  curl -X PUT -H "X-Session-ID: 0123456789" -H "Content-Type:application/json" --data @data.json "https://lor.instructure.com/api/resources/9cd972bef89b9fc7de6357a473f845db/reviews/self"
  data.json:
  {
    "body": "I find your lack of faith disturbing",
    "rating": 1
  }

Authorizations

SessionAuth

x-session-idstringRequired

Session authentication. The session ID can be provided in any of the following ways: [Cookie: 'session'] [Header: 'x-session-id'] [Query parameter: 'session-id'] [Query parameter: first value of 'state'] [Body property: 'sessionId']

Path parameters

resourceIdstringRequired

The id of the resource to review

Body

application/json

anyOptional

or

anyOptional

Responses

200

Review updated successfully

application/json

201

Review created successfully

application/json

4XX

Bad Request

application/json

put

/api/resources/{resourceId}/reviews/self

HTTPcURLJavaScriptPython

PUT /api/resources/{resourceId}/reviews/self HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "body": "I find your lack of faith disturbing",
  "rating": 1
}

{
  "body": "text",
  "createDate": "2025-12-31T00:19:09.013Z",
  "resourceId": "text",
  "rating": 1,
  "updateDate": "2025-12-31T00:19:09.013Z",
  "userAvatarUrl": "text",
  "userFullName": "text",
  "userId": "text",
  "voteCount": 1
}

Get a Review

get

https://lor.instructure.comhttps://lor-beta.instructure.comhttps://commons.eu-central.canvaslms.comhttps://commons-fra-beta.instructure.comhttps://commons.ca-central.canvaslms.comhttps://commons-yul-beta.instructure.comhttps://commons.sydney.canvaslms.comhttps://commons-syd-beta.instructure.comhttps://commons.singapore.canvaslms.comhttps://commons-sin-beta.instructure.com

/api/resources/{resourceId}/reviews/self

Get a review for the resource that was authored by the current user.

Example:

  curl -X GET -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/resources/9cd972bef89b9fc7de6357a473f845db/reviews/self"

Authorizations

SessionAuth

x-session-idstringRequired

Session authentication. The session ID can be provided in any of the following ways: [Cookie: 'session'] [Header: 'x-session-id'] [Query parameter: 'session-id'] [Query parameter: first value of 'state'] [Body property: 'sessionId']

Path parameters

resourceIdstringRequired

The id of the resource to get the review for

Responses

200

Review found

application/json

404

Review not found

application/json

get

/api/resources/{resourceId}/reviews/self

HTTPcURLJavaScriptPython

GET /api/resources/{resourceId}/reviews/self HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "body": "text",
  "createDate": "2025-12-31T00:19:09.013Z",
  "resourceId": "text",
  "rating": 1,
  "updateDate": "2025-12-31T00:19:09.013Z",
  "userAvatarUrl": "text",
  "userFullName": "text",
  "userId": "text",
  "voteCount": 1
}

Destroy Review by This User

delete

https://lor.instructure.comhttps://lor-beta.instructure.comhttps://commons.eu-central.canvaslms.comhttps://commons-fra-beta.instructure.comhttps://commons.ca-central.canvaslms.comhttps://commons-yul-beta.instructure.comhttps://commons.sydney.canvaslms.comhttps://commons-syd-beta.instructure.comhttps://commons.singapore.canvaslms.comhttps://commons-sin-beta.instructure.com

/api/resources/{resourceId}/reviews/self

Destroy a user's review for this resource.

Example:

  curl -X DELETE -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/resources/9cd972bef89b9fc7de6357a473f845db/reviews/self"

Authorizations

SessionAuth

x-session-idstringRequired

Session authentication. The session ID can be provided in any of the following ways: [Cookie: 'session'] [Header: 'x-session-id'] [Query parameter: 'session-id'] [Query parameter: first value of 'state'] [Body property: 'sessionId']

Path parameters

resourceIdstringRequired

The id of the resource to delete the review for

Responses

204

Review deleted successfully

4XX

Bad Request

application/json

delete

/api/resources/{resourceId}/reviews/self

HTTPcURLJavaScriptPython

DELETE /api/resources/{resourceId}/reviews/self HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

No content

List Reviews for a Resource

get

https://lor.instructure.comhttps://lor-beta.instructure.comhttps://commons.eu-central.canvaslms.comhttps://commons-fra-beta.instructure.comhttps://commons.ca-central.canvaslms.comhttps://commons-yul-beta.instructure.comhttps://commons.sydney.canvaslms.comhttps://commons-syd-beta.instructure.comhttps://commons.singapore.canvaslms.comhttps://commons-sin-beta.instructure.com

/api/resources/{resourceId}/reviews

List reviews for the specified resource.

curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/resources/0123456789/reviews?cursor=abcdefg"

Authorizations

SessionAuth

x-session-idstringRequired

Session authentication. The session ID can be provided in any of the following ways: [Cookie: 'session'] [Header: 'x-session-id'] [Query parameter: 'session-id'] [Query parameter: first value of 'state'] [Body property: 'sessionId']

Path parameters

resourceIdstringRequired

The id of the resource to list reviews for

Query parameters

cursorstringOptional

An identifier from a prior query to continue retrieving results for

Responses

200

List of reviews for a resource

application/json

4XX

Bad Request

application/json

get

/api/resources/{resourceId}/reviews

HTTPcURLJavaScriptPython

GET /api/resources/{resourceId}/reviews HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "body": "text",
      "createDate": "2025-12-31T00:19:09.013Z",
      "resourceId": "text",
      "rating": 1,
      "updateDate": "2025-12-31T00:19:09.013Z",
      "userAvatarUrl": "text",
      "userFullName": "text",
      "userId": "text",
      "voteCount": 1
    }
  ],
  "meta": {
    "cursor": "text"
  }
}