Bookmarks

Welcome to Our New API Docs! This is the new home for all things API (previously at Canvas LMS REST API Documentation).

Bookmarks API

A Bookmark object looks like:

{
  "id": 1,
  "name": "Biology 101",
  "url": "/courses/1",
  "position": 1,
  "data": {"active_tab":1}
}

List bookmarks

Bookmarks::BookmarksController#index

GET /api/v1/users/self/bookmarks

Scope: url:GET|/api/v1/users/self/bookmarks

Returns the paginated list of bookmarks.

Example Request:

curl 'https://<canvas>/api/v1/users/self/bookmarks' \
     -H 'Authorization: Bearer <token>'

Returns a list of Bookmark objects.

Create bookmark

Bookmarks::BookmarksController#create

POST /api/v1/users/self/bookmarks

Scope: url:POST|/api/v1/users/self/bookmarks

Creates a bookmark.

Request Parameters:

Parameter	Type	Description
name	string	The name of the bookmark
url	string	The url of the bookmark
position	integer	The position of the bookmark. Defaults to the bottom.
data	string	The data associated with the bookmark

Example Request:

curl 'https://<canvas>/api/v1/users/self/bookmarks' \
     -F 'name=Biology 101' \
     -F 'url=/courses/1' \
     -H 'Authorization: Bearer <token>'

Returns a Bookmark object.

Get bookmark

Bookmarks::BookmarksController#show

GET /api/v1/users/self/bookmarks/:id

Scope: url:GET|/api/v1/users/self/bookmarks/:id

Returns the details for a bookmark.

Example Request:

curl 'https://<canvas>/api/v1/users/self/bookmarks/1' \
     -H 'Authorization: Bearer <token>'

Returns a Bookmark object.

Update bookmark

Bookmarks::BookmarksController#update

PUT /api/v1/users/self/bookmarks/:id

Scope: url:PUT|/api/v1/users/self/bookmarks/:id

Updates a bookmark

Request Parameters:

Parameter	Type	Description
name	string	The name of the bookmark
url	string	The url of the bookmark
position	integer	The position of the bookmark. Defaults to the bottom.
data	string	The data associated with the bookmark

Example Request:

curl -X PUT 'https://<canvas>/api/v1/users/self/bookmarks/1' \
     -F 'name=Biology 101' \
     -F 'url=/courses/1' \
     -H 'Authorization: Bearer <token>'

Returns a Folder object.

Delete bookmark

Bookmarks::BookmarksController#destroy

DELETE /api/v1/users/self/bookmarks/:id

Scope: url:DELETE|/api/v1/users/self/bookmarks/:id

Deletes a bookmark

Example Request:

curl -X DELETE 'https://<canvas>/api/v1/users/self/bookmarks/1' \
     -H 'Authorization: Bearer <token>'

---

This documentation is generated directly from the Canvas LMS source code, available on Github.