Pages API

Pages are rich content associated with Courses and Groups in Canvas. The Pages API allows you to create, retrieve, update, and delete pages.

A Page object looks like:

{
  // the unique locator for the page
  "url": "my-page-title",
  // the title of the page
  "title": "My Page Title",
  // the creation date for the page
  "created_at": "2012-08-06T16:46:33-06:00",
  // the date the page was last updated
  "updated_at": "2012-08-08T14:25:20-06:00",
  // (DEPRECATED) whether this page is hidden from students (note: this is always
  // reflected as the inverse of the published value)
  "hide_from_students": false,
  // roles allowed to edit the page; comma-separated list comprising a combination of
  // 'teachers', 'students', 'members', and/or 'public' if not supplied, course
  // defaults are used
  "editing_roles": "teachers,students",
  // the User who last edited the page (this may not be present if the page was
  // imported from another system)
  "last_edited_by": null,
  // the page content, in HTML (present when requesting a single page; omitted when
  // listing pages)
  "body": "<p>Page Content</p>",
  // whether the page is published (true) or draft state (false).
  "published": true,
  // whether this page is the front page for the wiki
  "front_page": false,
  // Whether or not this is locked for the user.
  "locked_for_user": false,
  // (Optional) Information for the user about the lock. Present when locked_for_user
  // is true.
  "lock_info": null,
  // (Optional) An explanation of why this is locked for the user. Present when
  // locked_for_user is true.
  "lock_explanation": "This page is locked until September 1 at 12:00am"
}

A PageRevision object looks like:

{
  // an identifier for this revision of the page
  "revision_id": 7,
  // the time when this revision was saved
  "updated_at": "2012-08-07T11:23:58-06:00",
  // whether this is the latest revision or not
  "latest": true,
  // the User who saved this revision, if applicable (this may not be present if the
  // page was imported from another system)
  "edited_by": null,
  // the following fields are not included in the index action and may be omitted
  // from the show action via summary=1 the historic url of the page
  "url": "old-page-title",
  // the historic page title
  "title": "Old Page Title",
  // the historic page contents
  "body": "<p>Old Page Content</p>"
}

Show front page WikiPagesApiController#show_front_page

GET /api/v1/courses/:course_id/front_page

GET /api/v1/groups/:group_id/front_page

Retrieve the content of the front page

Example Request:

curl -H 'Authorization: Bearer <token>' \
     https://<canvas>/api/v1/courses/123/front_page

Returns a Page

Update/create front page WikiPagesApiController#update_front_page

PUT /api/v1/courses/:course_id/front_page

PUT /api/v1/groups/:group_id/front_page

Update the title or contents of the front page

Request Parameters:

Parameter	Type	Description
wiki_page[title]	string	The title for the new page. NOTE: changing a page's title will change its url. The updated url will be returned in the result.
wiki_page[body]	string	The content for the new page.
wiki_page[editing_roles]	string	Which user roles are allowed to edit this page. Any combination of these roles is allowed (separated by commas). “teachers” Allows editing by teachers in the course. “students” Allows editing by students in the course. “members” For group wikis, allows editing by members of the group. “public” Allows editing by any user. Allowed values: `teachers`, `students`, `members`, `public`
wiki_page[notify_of_update]	boolean	Whether participants should be notified when this page changes.
wiki_page[published]	boolean	Whether the page is published (true) or draft state (false).

Example Request:

curl -X PUT -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/courses/123/front_page \
-d wiki_page[body]=Updated+body+text

Returns a Page

List pages WikiPagesApiController#index

GET /api/v1/courses/:course_id/pages

GET /api/v1/groups/:group_id/pages

List the wiki pages associated with a course or group

Request Parameters:

Parameter	Type	Description
sort	string	Sort results by this field. Allowed values: `title`, `created_at`, `updated_at`
order	string	The sorting order. Defaults to 'asc'. Allowed values: `asc`, `desc`
search_term	string	The partial title of the pages to match and return.
published	boolean	If true, include only published paqes. If false, exclude published pages. If not present, do not filter on published status.

Example Request:

curl -H 'Authorization: Bearer <token>' \
     https://<canvas>/api/v1/courses/123/pages?sort=title&order=asc

Returns a list of Pages

Create page WikiPagesApiController#create

POST /api/v1/courses/:course_id/pages

POST /api/v1/groups/:group_id/pages

Create a new wiki page

Request Parameters:

Parameter		Type	Description
wiki_page[title]	Required	string	The title for the new page.
wiki_page[body]		string	The content for the new page.
wiki_page[editing_roles]		string	Which user roles are allowed to edit this page. Any combination of these roles is allowed (separated by commas). “teachers” Allows editing by teachers in the course. “students” Allows editing by students in the course. “members” For group wikis, allows editing by members of the group. “public” Allows editing by any user. Allowed values: `teachers`, `students`, `members`, `public`
wiki_page[notify_of_update]		boolean	Whether participants should be notified when this page changes.
wiki_page[published]		boolean	Whether the page is published (true) or draft state (false).
wiki_page[front_page]		boolean	Set an unhidden page as the front page (if true)

Example Request:

curl -X POST -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/courses/123/pages \
-d wiki_page[title]=New+page
-d wiki_page[body]=New+body+text

Returns a Page

Show page WikiPagesApiController#show

GET /api/v1/courses/:course_id/pages/:url

GET /api/v1/groups/:group_id/pages/:url

Retrieve the content of a wiki page

Example Request:

curl -H 'Authorization: Bearer <token>' \
     https://<canvas>/api/v1/courses/123/pages/my-page-url

Returns a Page

Update/create page WikiPagesApiController#update

PUT /api/v1/courses/:course_id/pages/:url

PUT /api/v1/groups/:group_id/pages/:url

Update the title or contents of a wiki page

Request Parameters:

Parameter	Type	Description
wiki_page[title]	string	The title for the new page. NOTE: changing a page's title will change its url. The updated url will be returned in the result.
wiki_page[body]	string	The content for the new page.
wiki_page[editing_roles]	string	Which user roles are allowed to edit this page. Any combination of these roles is allowed (separated by commas). “teachers” Allows editing by teachers in the course. “students” Allows editing by students in the course. “members” For group wikis, allows editing by members of the group. “public” Allows editing by any user. Allowed values: `teachers`, `students`, `members`, `public`
wiki_page[notify_of_update]	boolean	Whether participants should be notified when this page changes.
wiki_page[published]	boolean	Whether the page is published (true) or draft state (false).
wiki_page[front_page]	boolean	Set an unhidden page as the front page (if true)

Example Request:

curl -X PUT -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/courses/123/pages/the-page-url \
-d 'wiki_page[body]=Updated+body+text'

Returns a Page

Delete page WikiPagesApiController#destroy

DELETE /api/v1/courses/:course_id/pages/:url

DELETE /api/v1/groups/:group_id/pages/:url

Delete a wiki page

Example Request:

curl -X DELETE -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/courses/123/pages/the-page-url

Returns a Page

List revisions WikiPagesApiController#revisions

GET /api/v1/courses/:course_id/pages/:url/revisions

GET /api/v1/groups/:group_id/pages/:url/revisions

List the revisions of a page. Callers must have update rights on the page in order to see page history.

Example Request:

curl -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/courses/123/pages/the-page-url/revisions

Returns a list of PageRevisions

Show revision WikiPagesApiController#show_revision

GET /api/v1/courses/:course_id/pages/:url/revisions/latest

GET /api/v1/groups/:group_id/pages/:url/revisions/latest

GET /api/v1/courses/:course_id/pages/:url/revisions/:revision_id

GET /api/v1/groups/:group_id/pages/:url/revisions/:revision_id

Retrieve the metadata and optionally content of a revision of the page. Note that retrieving historic versions of pages requires edit rights.

Request Parameters:

Parameter		Type	Description
summary		boolean	If set, exclude page content from results

Example Request:

curl -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/courses/123/pages/the-page-url/revisions/latest

curl -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/courses/123/pages/the-page-url/revisions/4

Returns a PageRevision

Revert to revision WikiPagesApiController#revert

POST /api/v1/courses/:course_id/pages/:url/revisions/:revision_id

POST /api/v1/groups/:group_id/pages/:url/revisions/:revision_id

Revert a page to a prior revision.

Request Parameters:

Parameter		Type	Description
revision_id	Required	integer	The revision to revert to (use the List Revisions API to see available revisions)

Example Request:

curl -X POST -H 'Authorization: Bearer <token>' \
https://<canvas>/api/v1/courses/123/pages/the-page-url/revisions/6

Returns a PageRevision