Canvas

Canvas Pages API

The Pages API from Canvas — 13 operation(s) for pages.

GitHub OpenAPI

Operations 23

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/courses/{course_id}/front_page Show a course's front page · Show front page #
Ask an LLM
“How do I get the content of a Canvas course's front page?”
“What is currently set as the home page of my course?”
Tell an agent
Show the front page of course {course_id}.
Get the title and body of the front page for course {course_id}.
PUT /v1/courses/{course_id}/front_page Update or create a course's front page · Update/create front page #
Ask an LLM
“Can I change the title or body of my course's front page?”
“Is it possible to notify students when I edit the course front page?”
Tell an agent
Set the front page title of course {course_id} to {title}.
Replace the course {course_id} front page body with {body} and publish it as {published}.
GET /v1/groups/{group_id}/front_page Show a group's front page · Show front page #
Ask an LLM
“How do I read the front page of a student group?”
“What does a group's wiki home page currently say?”
Tell an agent
Show the front page of group {group_id}.
Fetch the group {group_id} home wiki page content.
PUT /v1/groups/{group_id}/front_page Update or create a group's front page · Update/create front page #
Ask an LLM
“Can I edit the front page of a group's wiki?”
“Who can edit a group front page, and can I restrict editing roles?”
Tell an agent
Set the front page title of group {group_id} to {title}.
Update group {group_id}'s front page body to {body} with editing roles {editing_roles}.
POST /v1/courses/{course_id}/pages/{url_or_id}/duplicate Duplicate a course wiki page · Duplicate page #
Ask an LLM
“How do I make a copy of an existing wiki page in a course?”
“Can I clone a course page instead of rebuilding it from scratch?”
Tell an agent
Duplicate page {url_or_id} in course {course_id}.
Make a copy of the {url_or_id} page in course {course_id}.
GET /v1/courses/{course_id}/pages List a course's wiki pages · List pages #
Ask an LLM
“How do I list all the wiki pages in a course?”
“Can I search a course's pages by title or show only unpublished ones?”
Tell an agent
List the pages in course {course_id}.
Search course {course_id} pages for {search_term}, sorted by {sort}.
POST /v1/courses/{course_id}/pages Create a wiki page in a course · Create page #
Ask an LLM
“How do I add a new content page to my course?”
“Can I schedule a new course page to publish at a later date?”
Tell an agent
Create a page titled {title} in course {course_id}.
Add page {title} to course {course_id} with body {body}, publishing at {publish_at}.
GET /v1/groups/{group_id}/pages List a group's wiki pages · List pages #
Ask an LLM
“What wiki pages exist in a student group?”
“Can I filter a group's pages to published ones only?”
Tell an agent
List the pages in group {group_id}.
Find group {group_id} pages matching {search_term}.
POST /v1/groups/{group_id}/pages Create a wiki page in a group · Create page #
Ask an LLM
“How do I add a new wiki page to a group?”
“Can I make a new group page the group's front page right away?”
Tell an agent
Create a page titled {title} in group {group_id}.
Add group {group_id} page {title} and set it as front page {front_page}.
GET /v1/courses/{course_id}/pages/{url_or_id} Show a course wiki page · Show page #
Ask an LLM
“How do I get the content of one page in a course?”
“Can I fetch a course page by its URL slug rather than its id?”
Tell an agent
Show page {url_or_id} in course {course_id}.
Read the body of course {course_id} page {url_or_id}.
PUT /v1/courses/{course_id}/pages/{url_or_id} Update or create a course page by URL · Update/create page #
Ask an LLM
“How do I edit the title or body of an existing course page?”
“Why does passing a numeric page identifier sometimes create a new page instead of updating?”
Tell an agent
Update course {course_id} page {url_or_id} with body {body}.
Rename page {url_or_id} in course {course_id} to {title}.
DELETE /v1/courses/{course_id}/pages/{url_or_id} Delete a course wiki page · Delete page #
Ask an LLM
“How do I delete a page from my course?”
“Can I remove a course page using its URL slug?”
Tell an agent destructive · confirm first
Delete page {url_or_id} from course {course_id}.
Remove the course {course_id} wiki page {url_or_id}.
GET /v1/groups/{group_id}/pages/{url_or_id} Show a group wiki page · Show page #
Ask an LLM
“How do I read a specific page in a group's wiki?”
“Can I look up a group page by its URL?”
Tell an agent
Show page {url_or_id} in group {group_id}.
Read group {group_id} page {url_or_id}.
PUT /v1/groups/{group_id}/pages/{url_or_id} Update or create a group page by URL · Update/create page #
Ask an LLM
“Can I edit a page in a group's wiki?”
“Is it possible to unpublish a group page by updating it?”
Tell an agent
Update group {group_id} page {url_or_id} with body {body}.
Set group {group_id} page {url_or_id} published to {published}.
DELETE /v1/groups/{group_id}/pages/{url_or_id} Delete a group wiki page · Delete page #
Ask an LLM
“How do I delete a page from a group's wiki?”
“Can a group page be removed by its URL slug?”
Tell an agent destructive · confirm first
Delete page {url_or_id} from group {group_id}.
Remove the group {group_id} wiki page {url_or_id}.
GET /v1/courses/{course_id}/pages/{url_or_id}/revisions List revisions of a course page · List revisions #
Ask an LLM
“How do I see the edit history of a course page?”
“What permission do I need to view a course page's revisions?”
Tell an agent
List the revisions of page {url_or_id} in course {course_id}.
Show the version history for course {course_id} page {url_or_id}.
GET /v1/groups/{group_id}/pages/{url_or_id}/revisions List revisions of a group page · List revisions #
Ask an LLM
“How do I see who changed a group wiki page and when?”
“Can I list every revision of a page in a group?”
Tell an agent
List the revisions of page {url_or_id} in group {group_id}.
Show group {group_id} page {url_or_id} edit history.
GET /v1/courses/{course_id}/pages/{url_or_id}/revisions/latest Show the latest revision of a course page · Show revision #
Ask an LLM
“How do I get the most recent revision of a course page?”
“Can I get just the metadata of a course page's latest revision without its content?”
Tell an agent
Show the latest revision of page {url_or_id} in course {course_id}.
Get course {course_id} page {url_or_id} current revision with summary only {summary}.
GET /v1/groups/{group_id}/pages/{url_or_id}/revisions/latest Show the latest revision of a group page · Show revision #
Ask an LLM
“What is the most recent revision of a group wiki page?”
“Can I fetch only the summary of a group page's latest revision?”
Tell an agent
Show the latest revision of page {url_or_id} in group {group_id}.
Get group {group_id} page {url_or_id} newest revision, summary {summary}.
GET /v1/courses/{course_id}/pages/{url_or_id}/revisions/{revision_id} Show a specific revision of a course page · Show revision #
Ask an LLM
“How do I view an older version of a course page by revision number?”
“Do I need edit rights to see a historic revision of a course page?”
Tell an agent
Show revision {revision_id} of page {url_or_id} in course {course_id}.
Get the content of course {course_id} page {url_or_id} as of revision {revision_id}.
POST /v1/courses/{course_id}/pages/{url_or_id}/revisions/{revision_id} Revert a course page to a prior revision · Revert to revision #
Ask an LLM
“How do I roll a course page back to an earlier version?”
“Can I restore a course page that someone edited by mistake?”
Tell an agent
Revert page {url_or_id} in course {course_id} to revision {revision_id}.
Restore course {course_id} page {url_or_id} back to revision {revision_id}.
GET /v1/groups/{group_id}/pages/{url_or_id}/revisions/{revision_id} Show a specific revision of a group page · Show revision #
Ask an LLM
“How do I look at an old revision of a group wiki page?”
“Can I see what a group page said at a particular revision?”
Tell an agent
Show revision {revision_id} of page {url_or_id} in group {group_id}.
Get group {group_id} page {url_or_id} content at revision {revision_id}.
POST /v1/groups/{group_id}/pages/{url_or_id}/revisions/{revision_id} Revert a group page to a prior revision · Revert to revision #
Ask an LLM
“How do I roll back a group wiki page to an earlier revision?”
“Can I undo bad edits to a group page by restoring an old version?”
Tell an agent
Revert page {url_or_id} in group {group_id} to revision {revision_id}.
Restore group {group_id} page {url_or_id} back to revision {revision_id}.

Documentation

📖
Documentation
https://canvas.instructure.com/doc/api/
📖
Authentication
https://canvas.instructure.com/doc/api/file.oauth.html
📖
APIReference
https://canvas.instructure.com/doc/api/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/rate-limits/canvas-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/openapi/canvas-pages-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/instructure/canvas-lms

Other Resources

🔗
Pagination
https://canvas.instructure.com/doc/api/file.pagination.html
🔗
Swagger
https://canvas.instructure.com/doc/api/api-docs.json
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/scopes/canvas-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/errors/canvas-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/data-model/canvas-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canvas:canvas-pages-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canvas-pages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Canvas LMS REST Pages API
  version: v1
  summary: The complete Canvas LMS REST API, converted from the Swagger 1.2 documents Instructure publishes under https://canvas.instructure.com/doc/api/.
  description: The Canvas LMS REST API covers courses, assignments, quizzes, grades, users, enrollments, accounts, files, modules, rubrics, submissions, SIS imports, LTI, analytics and account administration.
  contact:
    name: Instructure Canvas
    url: https://canvas.instructure.com/doc/api/
  license:
    name: AGPL-3.0
    url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
servers:
- url: https://canvas.instructure.com/api
  description: Instructure-hosted Canvas (canvas.instructure.com)
- url: https://{canvas_host}/api
  description: Any Canvas instance; Canvas is multi-tenant and self-hostable, so the host is the institution's Canvas domain.
  variables:
    canvas_host:
      default: canvas.instructure.com
      description: Your institution's Canvas hostname, e.g. school.instructure.com
security:
- bearerAuth: []
- oauth2: []
tags:


# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/openapi/canvas-pages-api-openapi.yml