API Change Log

What is the API Change Log?

The API Change Log includes adjustments to the Canvas API documentation as part of each Canvas release. This change log can be updated at any time. Instructure may add, change, and deprecate API elements according to the timelines indicated in the Canvas API Policy page.

How do I use the API Change Log?

2019-01-26

Changes

API Calls Function
Submissions API List Gradeable Students endpoint Added clarification about anonymous grading

Additions

API Responses Function
Assignments API Assignment Object Returns grader_count, ginal_grader, grader_comments_visible_to_graders, graders_anonymous_to_graders, grader_names_visible_to_final_grader, and anonymous_grading parameters
Submissions API Submission Object Returns UserDisplay parameter
Users API Added AnonyousUserDisplay Object

Removals

API Responses Function
Enrollments API Enrollment Object Removed computed_current_score, computed_final_score, computed_current_grade, computed_final_grade, current_period_computed_current_score, current_period_computed_final_score, current_period_computed_current_grade, and current_period_computed_final_grade parameters

2019-01-05

Changes

API Calls Function
Developer Keys API Verified and corrected all links in document
Files API Delete File Endpoint Clarified endpoint usage and added permanent deletion warning

Additions

API Calls Function
Assignments API Create an Assignment Endpoint

Edit an Assignment Endpoint
Added assignment[allowed_attempts] parameter
Conversations API Create a Conversations Endpoint Added force_new parameter
Courses API Get a Single Course Endpoint Added teacher_limit parameter
Roles API Create a New Role Endpoint Permissions_enabled parameter: Added view_audit_trail in permissions list

API Responses Function
Assignments API Assignment Object Added allowed_attempts parameter
Enrollments API Enrollment Object Added override_grade, override_score, current_period_override_grade, and current_period_override_score parameters

Added override score clarifications in computed_current_score, computed_final_score, computed_final_grade, current_period_computed_current_score, current_period_computed_final_score, current_period_computed_current_grade, and current_period_computed_final_grade parameters
SIS Imports API SIS Import Statistic Object

SIS Import Statistic Objects
Added object examples
SIS Imports API SIS Import Object Workflow_state parameter: Added initializing and failed descriptions

Added statistics parameter
Submissions API Submission Object Added extra_attempts parameter

Removals

API Calls Function
Courses API List Users in Course Endpoint Include parameter: Removed email as an optional parameter

Content Function
Navigation Tools Removed incorrect auto-generated links from page

2018-12-08

Changes

API Calls Function
SIS Imports API Abort SIS Import Endpoint

Get SIS Import List Endpoint
Added clarification that aborting a sis batch can take time and subsequent sis batches begin to process 10 minutes after the abort.

Workflow_state parameter: added initializing, failed, restoring, partially_restored, and restored as allowed values

Additions

API Calls Function
SIS Import Errors API SISImportError Object Added row_info parameter, which displays the contents of the line that had the error
Users API List the Activity Stream Endpoint Added only_active_courses parameter

API Responses Function
Courses API List Your Courses Endpoint Include parameter: Added graded period parameters to be returned even if total grades are hidden in the course

2018-11-17

Changes

API Calls Function
Roles API Create a New Role Endpoint Permissions parameter: Updated account- and course-level role names to match roles in the Canvas Permissions page

API Responses Function
Assignments API List Assignments Endpoint Clarified that the paginated list of assignments is returned for the current course or assignment group
Rubrics API Create a Single Rubric Endpoint Clarified the rubric return value

Additions

API Calls Function
LTI Variable Substitutions com.instructure.Person.name_sortable Added variable that returns the sortable name of the launching user. Availability is when launched by a logged in user

API Responses Function
SIS Imports API Get the Current Importing SIS Import Endpoint Added endpoint to return the SIS imports that are currently processing for an account

Removals

API Calls Function
Planner API Removed the beta warning banner from the API documentation