Collection
Last updated
Was this helpful?
Last updated
Was this helpful?
Was this helpful?
The page to retrieve. Default: 1.
1
The number of results per page. Default: 20, Max: 50.
20
The collections the authenticated user has permission to.
Authorization information is missing or invalid.
GET /api/public/v1/collections HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"collections": [
{
"id": 1,
"name": "text",
"type": "text",
"permission": "text",
"owner": {
"id": 1,
"full_name": "text",
"display_name": "text",
"email": "text"
},
"created_at": "2025-08-25T13:23:04.303Z",
"course_id": 1
}
]
}
The name of the collection.
ID of the user to create the collection on behalf of. If not provided, the collection will be created in the requestor's library
The collection object that was created.
Authorization information is missing or invalid.
If a user without permission tries to call this endpoint with user_id parameter, the call is rejected with 403 Forbidden.
The user was not found by id.
Invalid user_id is provided.
POST /api/public/v1/collections HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"collection": {
"id": 1,
"name": "text",
"type": "text",
"permission": "text",
"owner": {
"id": 1,
"full_name": "text",
"display_name": "text",
"email": "text"
},
"created_at": "2025-08-25T13:23:04.303Z",
"course_id": 1
}
}
The ID of the collection.
The collection object.
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
The collection was not found.
Invalid collection_id is provided.
GET /api/public/v1/collections/{collection_id} HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"collection": {
"id": 1,
"name": "text",
"type": "text",
"permission": "text",
"owner": {
"id": 1,
"full_name": "text",
"display_name": "text",
"email": "text"
},
"created_at": "2025-08-25T13:23:04.303Z",
"course_id": 1
}
}
The ID of the collection
The page to retrieve. Default: 1.
1
The number of results per page. Default: 20, Max: 50.
20
The list of media in a specific collection.
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
The collection was not found by ID.
GET /api/public/v1/collections/{collection_id}/media HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"media": [
{
"id": 1,
"title": "text",
"description": "text",
"duration": 1,
"created_at": "2025-08-25T13:23:04.303Z",
"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"
}
]
}
The ID of the collection.
List of users and groups extended with permission type.
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
The collection was not found.
Invalid collection_id is provided.
GET /api/public/v1/collections/{collection_id}/permissions HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"users": [
{
"id": 1,
"full_name": "text",
"display_name": "text",
"email": "text",
"permission": "text"
}
],
"groups": [
{
"id": 1,
"name": "text",
"permission": "text"
}
]
}
The ID of the collection.
An array with objects describing the permissions to add or update or destroy.
The action to perform.
The id of the user or group.
The share type.
The permission type. The default is "view".
view
Possible values: Permissions were added, the updated list of permissions is returned.
One ore more permission was not found or can not be created, because already exists
Authorization information is missing or invalid.
If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.
The collection was not found.
Invalid collection_id is provided.
POST /api/public/v1/collections/{collection_id}/permissions HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73
[
{
"action": "create",
"id": 1,
"share_type": "user",
"permission_type": "view"
}
]
{
"users": [
{
"id": 1,
"full_name": "text",
"display_name": "text",
"email": "text",
"permission": "text"
}
],
"groups": [
{
"id": 1,
"name": "text",
"permission": "text"
}
]
}