Users

List User's Imported Resources (DEPRECATED)

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/users/{id}/imports

DEPRECATED (use GET /resources?onlyImported=true instead) List all of the resources the current user has imported.

Example: curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/users/0123456789/imports?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

idstringRequired

The current session user id

Query parameters

cursorstringOptional

An identifier from a prior result to continue retrieving results

Responses

200

List of imported resources

application/json

4XX

Bad Request

application/json

get

/api/users/{id}/imports

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "account": {
        "id": "text",
        "name": "text"
      },
      "scopeIds": [
        "text"
      ],
      "type": "text",
      "createDate": 1,
      "createUserId": "text",
      "updateDate": 1,
      "updateUserId": "text",
      "authors": [
        {
          "id": "text",
          "name": "text",
          "avatarUrl": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "thumbnail": {
        "url": "text",
        "description": "text"
      },
      "gradeIds": [
        "text"
      ],
      "licenseIds": [
        "text"
      ],
      "subjectIds": [
        "text"
      ],
      "meta": {
        "links": {
          "self": "text"
        },
        "permissions": {
          "read": true,
          "write": true
        }
      },
      "available": true
    }
  ],
  "meta": {
    "cursor": "text"
  }
}

List Available Updates to Resources

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/users/{userId}/updates

List all of the updates to resources the current user has imported.

Example: curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/users/0123456789/updates?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

userIdstringRequired

The current session user id

Query parameters

cursorstringOptional

An identifier from a prior result to continue retrieving results

Responses

200

List of updates to resources available

application/json

4XX

Bad Request

application/json

get

/api/users/{userId}/updates

HTTPcURLJavaScriptPython

GET /api/users/{userId}/updates HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "updateDate": 1,
      "createDate": 1,
      "lastUpdateDate": 1,
      "versionId": "text",
      "versionNotes": "text",
      "mediaObjectDuration": 1,
      "courses": [
        {
          "versionCreateDate": 1,
          "importDate": 1,
          "courseId": "text",
          "courseName": "text"
        }
      ],
      "resource": {
        "id": "text",
        "title": "text",
        "description": "text",
        "account": {
          "id": "text",
          "name": "text"
        },
        "scopeIds": [
          "text"
        ],
        "type": "text",
        "createDate": 1,
        "createUserId": "text",
        "updateDate": 1,
        "updateUserId": "text",
        "authors": [
          {
            "id": "text",
            "name": "text",
            "avatarUrl": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "thumbnail": {
          "url": "text",
          "description": "text"
        },
        "gradeIds": [
          "text"
        ],
        "licenseIds": [
          "text"
        ],
        "subjectIds": [
          "text"
        ],
        "meta": {
          "links": {
            "self": "text"
          },
          "permissions": {
            "read": true,
            "write": true
          }
        },
        "versions": [
          {
            "id": "text",
            "resourceId": "text",
            "exportStatus": "text",
            "exportStatusDate": 1,
            "size": 1,
            "mimeType": "text",
            "mediaObjectId": "text",
            "mediaObjectDuration": 1,
            "resourceType": "text",
            "versionNotes": "text",
            "createDate": 1,
            "createUserId": "text",
            "updateDate": 1,
            "updateUserId": "text"
          }
        ]
      }
    }
  ],
  "meta": {
    "count": 1,
    "cursor": "text"
  }
}

Get Update to 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/users/{userId}/updates/{resourceId}

Get the update information for a resource the current user has imported, if available.

Example: curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/users/0123456789/updates/c8d82b560d094c8e82ca0e4e59145e06"

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

userIdstringRequired

The current session user id

resourceIdstringRequired

A resource's unique id

Responses

200

Update information for the resource

application/json

4XX

Bad Request

application/json

get

/api/users/{userId}/updates/{resourceId}

HTTPcURLJavaScriptPython

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

{
  "updateDate": 1,
  "createDate": 1,
  "lastUpdateDate": 1,
  "versionId": "text",
  "versionNotes": "text",
  "mediaObjectDuration": 1,
  "courses": [
    {
      "versionCreateDate": 1,
      "importDate": 1,
      "courseId": "text",
      "courseName": "text"
    }
  ],
  "resource": {
    "id": "text",
    "title": "text",
    "description": "text",
    "account": {
      "id": "text",
      "name": "text"
    },
    "scopeIds": [
      "text"
    ],
    "type": "text",
    "createDate": 1,
    "createUserId": "text",
    "updateDate": 1,
    "updateUserId": "text",
    "authors": [
      {
        "id": "text",
        "name": "text",
        "avatarUrl": "text"
      }
    ],
    "tags": [
      "text"
    ],
    "thumbnail": {
      "url": "text",
      "description": "text"
    },
    "gradeIds": [
      "text"
    ],
    "licenseIds": [
      "text"
    ],
    "licenseSpecs": "text",
    "subjectIds": [
      "text"
    ],
    "meta": {
      "links": {
        "self": "text"
      },
      "permissions": {
        "read": true,
        "write": true
      }
    },
    "versions": [
      {
        "id": "text",
        "resourceId": "text",
        "exportStatus": "text",
        "exportStatusDate": 1,
        "size": 1,
        "mimeType": "text",
        "mediaObjectId": "text",
        "mediaObjectDuration": 1,
        "resourceType": "text",
        "versionNotes": "text",
        "createDate": 1,
        "createUserId": "text",
        "updateDate": 1,
        "updateUserId": "text"
      }
    ]
  }
}

Ignore Updates

post

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/users/{userId}/updates/{resourceId}/ignore

Ignore this update for particular courses that previously had imported the resource.

Example: curl -X POST -H "X-Session-ID: 0123456789" -H "Content-Type:application/json" -d '{"courseIds":["123","456"]}' "https://lor.instructure.com/api/users/0123456789/updates/9145e06/ignore"

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

userIdstringRequired

The current session user id

resourceIdstringRequired

A resource's unique id

Body

application/json

courseIdsstring[]Optional

A list of ids for courses to ignore for this update

Responses

204

No Content

4XX

Bad Request

application/json

post

/api/users/{userId}/updates/{resourceId}/ignore

HTTPcURLJavaScriptPython

POST /api/users/{userId}/updates/{resourceId}/ignore HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "courseIds": [
    "text"
  ]
}

No content

List User's Favorite Resources

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/users/{userId}/favorites

List all of the resources the current user has marked as Favorite.

Example: curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/users/0123456789/favorites"

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

userIdstringRequired

The current session user id

Responses

200

List of favorite resources

application/json

get

/api/users/{userId}/favorites

HTTPcURLJavaScriptPython

GET /api/users/{userId}/favorites HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

200

List of favorite resources

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "account": {
        "id": "text",
        "name": "text"
      },
      "scopeIds": [
        "text"
      ],
      "type": "text",
      "lang": "text",
      "createDate": "2025-12-31T00:24:46.749Z",
      "createUserId": "text",
      "updateDate": "2025-12-31T00:24:46.749Z",
      "updateUserId": "text",
      "authors": [
        {
          "id": "text",
          "name": "text",
          "avatarUrl": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "thumbnail": {
        "url": "text",
        "description": "text"
      },
      "licenseIds": [
        "text"
      ],
      "favoritedCount": "text",
      "outcomes": [
        "text"
      ],
      "meta": {
        "links": {
          "self": "text"
        },
        "permissions": {
          "read": true,
          "write": true
        }
      }
    }
  ]
}

Mark Resource as Favorite

post

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/users/{userId}/favorites

Adds a resource to the current user's favorites list.

Example:

  curl -X POST -H "X-Session-ID: 0123456789" -H "Content-Type: application/json" --data @data.json "https://lor.instructure.com/api/users/1234/favorites"
  data.json:
    {
      "resourceId": "ajk123"
    }

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

userIdstringRequired

The current session user id

Body

application/json

resourceIdstringRequired

The resourceId to mark as favorite

Responses

201

List of all favorite resources of the current user

application/json

4XX

Bad Request

application/json

post

/api/users/{userId}/favorites

HTTPcURLJavaScriptPython

POST /api/users/{userId}/favorites HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "resourceId": "ajk123abc123"
}

{
  "items": [
    {
      "userId": "text",
      "learningObjectId": "text",
      "createDate": "2025-12-31T00:24:46.749Z"
    }
  ]
}

Returns Canvas profile URL

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/users/{userId}/profile

Returns the Canvas profile URL for the specified user.

Example: curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/users/abcdef/profile"

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

userIdstringRequired

The ID of the user you want to see in Canvas

Responses

200

Ok

4XX

Bad Request

application/json

get

/api/users/{userId}/profile

HTTPcURLJavaScriptPython

GET /api/users/{userId}/profile HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

No content

Unmark Resource from Favorites

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/users/{userId}/favorites/{resourceId}

Remove a resource from the current user's favorites list.

Example: curl -X DELETE -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/users/1234/favorites/56789"

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

userIdstringRequired

The current session user id

resourceIdstringRequired

The resourceId to unflag from user favorites

Responses

204

No-Content

4XX

Bad Request

application/json

delete

/api/users/{userId}/favorites/{resourceId}

HTTPcURLJavaScriptPython

DELETE /api/users/{userId}/favorites/{resourceId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

No content

Search all users

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/users

Search through a list of all of the users in your account. Only admins and group managers may access this.

Example: curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/users?q=aaron"

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']

Query parameters

qstring · min: 3Required

The text to search for in the name or e-mail of the users. The results will be empty until the minimum length of 3 characters is satisfied.

cursorstringOptional

An identifier from a prior query to continue retrieving results for.

Responses

200

An array of all of the users found matching the search

application/json

4XX

Bad Request

application/json

get

/api/users

HTTPcURLJavaScriptPython

GET /api/users?q=text HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "uuid": "text",
      "fullName": "text",
      "email": "text",
      "accountId": "text"
    }
  ],
  "meta": {
    "count": 1,
    "cursor": "text"
  }
}