Users
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"
The current session user id
An identifier from a prior result to continue retrieving results
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 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"
The current session user id
An identifier from a prior result to continue retrieving results
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 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"
The current session user id
A resource's unique id
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 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"
The current session user id
A resource's unique id
A list of ids for courses to ignore for this update
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 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"
The current session user id
GET /api/users/{userId}/favorites HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*
List of favorite resources
{
"items": [
{
"id": "text",
"title": "text",
"description": "text",
"account": {
"id": "text",
"name": "text"
},
"scopeIds": [
"text"
],
"type": "text",
"lang": "text",
"createDate": "2025-07-01T00:33:37.315Z",
"createUserId": "text",
"updateDate": "2025-07-01T00:33:37.315Z",
"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
}
}
}
]
}
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"
}
The current session user id
The resourceId to mark as favorite
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-07-01T00:33:37.315Z"
}
]
}
Returns the Canvas profile URL for the specified user.
Example:
curl -H "X-Session-ID: 0123456789" "https://lor.instructure.com/api/users/abcdef/profile"
The ID of the user you want to see in Canvas
GET /api/users/{userId}/profile HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*
No content
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"
The current session user id
The resourceId to unflag from user favorites
DELETE /api/users/{userId}/favorites/{resourceId} HTTP/1.1
Host: lor.instructure.com
x-session-id: YOUR_API_KEY
Accept: */*
No content
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"
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.
An identifier from a prior query to continue retrieving results for.
GET /api/users 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"
}
}
Last updated
Was this helpful?