Canvas LMS

App · 20 actions

Read Canvas courses, enrollments, assignments, submissions, modules and pages, and manage assignments and modules.

Actions

ActionWhat it does
Create assignmentCreate assignment.
Create moduleCreate module.
Create pageCreate page.
Delete assignmentDelete assignment.
Delete moduleDelete module.
Delete pageDelete page.
Enroll userEnroll user.
Get assignmentGet assignment.
Get courseGet course.
Get moduleGet module.
Get pageGet page.
Get submissionGet submission.
List assignmentsList assignments.
List course usersList course users.
List coursesList courses.
List enrollmentsList enrollments.
List modulesList modules.
List pagesList pages.
List submissionsList submissions.
Update assignmentUpdate assignment.

Create assignment

Create assignment.

Inputs

Coursecourse_idtextRequired
ID
Assignment nameassignment_nametextRequired
The assignment name.
Assignment points possibleassignment_points_possiblenumber
The maximum points possible on the assignment.
Assignment grading typeassignment_grading_typetext
The strategy used for grading the assignment. The assignment defaults to "points" if this field is omitted.One of: pass_fail, percent, letter_grade, gpa_scale, points, not_graded.
Assignment due atassignment_due_atdate and time
The day/time the assignment is due. Must be between the lock dates if there are lock dates. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
Assignment lock atassignment_lock_atdate and time
The day/time the assignment is locked after. Must be after the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
Assignment unlock atassignment_unlock_atdate and time
The day/time the assignment is unlocked. Must be before the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
Assignment descriptionassignment_descriptiontext
The assignment's description, supports HTML.
Assignment publishedassignment_publishedtrue/false
Whether this assignment is published. (Only useful if 'draft state' account setting is on) Unpublished assignments are not visible to students.
Submission typesassignment_submission_typeslist
List of supported submission types for the assignment. Unless the assignment is allowing online submissions, the array should only have one element. If not allowing online submissions, your options are: "online_quiz" "none" "on_paper" "discussion_topic" "external_tool" If you are allowing online submissions, you can have one or many allowed submission types: "online_upload" "online_text_entry" "online_url" "media_recording" (Only valid when the Kaltura plugin is enabled) "student_annotation"One or more of: online_quiz, none, on_paper, discussion_topic, external_tool, online_upload, online_text_entry, online_url, media_recording, student_annotation.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create module

Create module.

Inputs

Coursecourse_idtextRequired
ID
Module namemodule_nametextRequired
The name of the module
Module unlock atmodule_unlock_atdate and time
The date the module will unlock
Module publish final grademodule_publish_final_gradetrue/false
Whether to publish the student's final grade for the course upon completion of this module.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create page

Create page.

Inputs

Coursecourse_idtextRequired
ID
TitletitletextRequired
The page title.
Contentbodytext
Page content as HTML.
Publishedpublishedtrue/false
Whether students can see this page.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Delete assignment

Delete assignment.

Inputs

Coursecourse_idtextRequired
ID
IdidtextRequired
ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Delete module

Delete module.

Inputs

Coursecourse_idtextRequired
ID
IdidtextRequired
ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Delete page

Delete page.

Inputs

Coursecourse_idtextRequired
ID
Url or idurl_or_idtextRequired
ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Enroll user

Enroll user.

Inputs

Coursecourse_idtextRequired
ID
Enrollment user idenrollment_user_idtextRequired
The ID of the user to be enrolled in the course.
Enrollment typeenrollment_typetextRequired
Enroll the user as a student, teacher, TA, observer, or designer. If no value is given, the type will be inferred by +enrollment[role]+ if supplied, otherwise 'StudentEnrollment' will be used.One of: StudentEnrollment, TeacherEnrollment, TaEnrollment, ObserverEnrollment, DesignerEnrollment.
Enrollment enrollment stateenrollment_enrollment_statetext
If set to 'active,' student will be immediately enrolled in the course. Otherwise they will be required to accept a course invitation. Default is 'invited.'. If set to 'inactive', student will be listed in the course roster for teachers, but will not be able to participate in the course until their enrollment is activated.One of: active, invited, inactive.
Enrollment notifyenrollment_notifytrue/false
If true, a notification will be sent to the enrolled user. Notifications are not sent by default.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get assignment

Get assignment.

Inputs

Coursecourse_idtextRequired
ID
IdidtextRequired
ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get course

Get course.

Inputs

IdidtextRequired
ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get module

Get module.

Inputs

Coursecourse_idtextRequired
ID
IdidtextRequired
ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get page

Get page.

Inputs

Coursecourse_idtextRequired
ID
Url or idurl_or_idtextRequired
ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get submission

Get submission.

Inputs

Coursecourse_idtextRequired
ID
Assignmentassignment_idtextRequired
ID
User idrecord_user_idtextRequired
ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List assignments

List assignments. Returns one page; use the continuation value for more records.

Inputs

Coursecourse_idtextRequired
ID
Search termsearch_termtext
The partial title of the assignments to match and return.
Pagepagenumber
Page number from the previous result.At least 1.
Per pageper_pagenumber
Records per page. Canvas can cap this value.At least 1.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List course users

List course users. Returns one page; use the continuation value for more records.

Inputs

Coursecourse_idtextRequired
ID
Search termsearch_termtext
The partial name or full ID of the users to match and return in the results list.
Enrollment typeenrollment_typelist
When set, only return users where the user is enrolled as this type. "student_view" implies include[]=test_student. This argument is ignored if enrollment_role is given.One or more of: teacher, student, student_view, ta, observer, designer.
Enrollment stateenrollment_statelist
When set, only return users where the enrollment workflow state is of one of the given types. "active" and "invited" enrollments are returned by default.One or more of: active, invited, rejected, completed, inactive.
Pagepagenumber
Page number from the previous result.At least 1.
Per pageper_pagenumber
Records per page. Canvas can cap this value.At least 1.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List courses

List courses. Returns one page; use the continuation value for more records.

Inputs

Enrollment typeenrollment_typetext
When set, only return courses where the user is enrolled as this type. For example, set to "teacher" to return only courses where the user is enrolled as a Teacher. This argument is ignored if enrollment_role is given.One of: teacher, student, ta, observer, designer.
Enrollment stateenrollment_statetext
When set, only return courses where the user has an enrollment with the given state. This will respect section/course/term date overrides.One of: active, invited_or_pending, completed.
Pagepagenumber
Page number from the previous result.At least 1.
Per pageper_pagenumber
Records per page. Canvas can cap this value.At least 1.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List enrollments

List enrollments. Returns one page; use the continuation value for more records.

Inputs

Coursecourse_idtextRequired
ID
Typetypelist
A list of enrollment types to return. Accepted values are 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'DesignerEnrollment', and 'ObserverEnrollment.' If omitted, all enrollment types are returned. This argument is ignored if `role` is given.
Pagepagenumber
Page number from the previous result.At least 1.
Per pageper_pagenumber
Records per page. Canvas can cap this value.At least 1.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List modules

List modules. Returns one page; use the continuation value for more records.

Inputs

Coursecourse_idtextRequired
ID
Search termsearch_termtext
The partial name of the modules (and module items, if 'items' is specified with include[]) to match and return.
Pagepagenumber
Page number from the previous result.At least 1.
Per pageper_pagenumber
Records per page. Canvas can cap this value.At least 1.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List pages

List pages. Returns one page; use the continuation value for more records.

Inputs

Coursecourse_idtextRequired
ID
Search termsearch_termtext
The partial title of the pages to match and return.
Pagepagenumber
Page number from the previous result.At least 1.
Per pageper_pagenumber
Records per page. Canvas can cap this value.At least 1.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List submissions

List submissions. Returns one page; use the continuation value for more records.

Inputs

Coursecourse_idtextRequired
ID
Assignmentassignment_idtextRequired
ID
Pagepagenumber
Page number from the previous result.At least 1.
Per pageper_pagenumber
Records per page. Canvas can cap this value.At least 1.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Update assignment

Update assignment.

Inputs

Coursecourse_idtextRequired
ID
IdidtextRequired
ID
Assignment nameassignment_nametext
The assignment name.
Assignment points possibleassignment_points_possiblenumber
The maximum points possible on the assignment.
Assignment grading typeassignment_grading_typetext
The strategy used for grading the assignment. The assignment defaults to "points" if this field is omitted.One of: pass_fail, percent, letter_grade, gpa_scale, points, not_graded.
Assignment due atassignment_due_atdate and time
The day/time the assignment is due. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
Assignment lock atassignment_lock_atdate and time
The day/time the assignment is locked after. Must be after the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
Assignment unlock atassignment_unlock_atdate and time
The day/time the assignment is unlocked. Must be before the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
Assignment descriptionassignment_descriptiontext
The assignment's description, supports HTML.
Assignment publishedassignment_publishedtrue/false
Whether this assignment is published. (Only useful if 'draft state' account setting is on) Unpublished assignments are not visible to students.
Submission typesassignment_submission_typeslist
List of supported submission types for the assignment. Unless the assignment is allowing online submissions, the array should only have one element. If not allowing online submissions, your options are: "online_quiz" "none" "on_paper" "discussion_topic" "external_tool" If you are allowing online submissions, you can have one or many allowed submission types: "online_upload" "online_text_entry" "online_url" "media_recording" (Only valid when the Kaltura plugin is enabled) "student_annotation"One or more of: online_quiz, none, on_paper, discussion_topic, external_tool, online_upload, online_text_entry, online_url, media_recording, student_annotation.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

On this page