Bookmarks

circle-exclamation

Bookmarks API

A Bookmark object looks like:

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

Bookmarks::BookmarksController#indexarrow-up-right

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.

Bookmarks::BookmarksController#createarrow-up-right

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:

Returns a Bookmark object.

Bookmarks::BookmarksController#showarrow-up-right

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

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

Returns the details for a bookmark.

Example Request:

Returns a Bookmark object.

Bookmarks::BookmarksController#updatearrow-up-right

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:

Returns a Folder object.

Bookmarks::BookmarksController#destroyarrow-up-right

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

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

Deletes a bookmark

Example Request:


This documentation is generated directly from the Canvas LMS source code, available on Githubarrow-up-right.

Last updated

Was this helpful?