Pages are ungraded content items that teachers can make available to students. For example, a teacher might choose to share a YouTube video resource with their course. Unlike with assignments, there isn't an expectation that the student will submit anything for a page. There is also no way to grade a page. If you're looking to create an item to be assigned or graded, please see the Assignments API instead.
Pages may be organized into Modules. For more information about modules, please see the Modules API.
Additional Notes
- Canvas only supports the
assignee_modeofallfor pages.- If you are looking to create a page that is only visible to a subset of students, you should use ungraded assignments instead.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the page. |
created_date | Date | When the page was created in the data source. |
updated_date | Date | When the page was last updated in the data source. |
properties | object | Non-standard properties that may be of interest to the developer. |
title | string | The title of the page. |
description | string | The description of the page. This will be used for LMS systems that support special formatting. |
description_plaintext | string | The description without special formatting. This will be used for systems that do not support formatting. |
state | PageState | The state of the page. |
attachments | Attachment[] | The attachments associated with the page. |
assignee_mode | AssigneeMode | The method by which the page's assignees are determined. |
assignee_ids | string[] | If assignee_mode is set to individuals, this should be a list of Person ids. |
section_ids | string[] | If assignee_mode is set to sections, this should be a list of Section ids. |
display_date | Date | The time at which the page becomes visible. |
module_id | string | The UUID of the associated Module. |
category_id | string | The UUID of the associated Category. This is currently only supported for Google Classroom |