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.
- For a summary of all deprecations, view the breaking changes API page.
- This page documents API changes for the last four releases. For prior releases, view the API Change Log archive page.
2018-06-23
Changes
| API Calls | Function | |
|---|---|---|
| Users API | Get a Pandata JWT Token and its Expiration Date endpoint | Changed endpoint to reflect use for current user only (/api/v1/users/self/pandata_token) Clarified description in that endpoint is currently only available to the mobile developer keys |
| API Responses | Function | |
|---|---|---|
| Files API | File Object | Updated file object example and ordering; object returns uuid, folder_id, display_name, and modified_at fields |
Additions
| API Calls | Function | |
|---|---|---|
| SIS Imports API | Restore workflow_states of SIS imported items | Added endpoint to restore states for sis_imports |
2018-06-02
Additions
| API Calls | Function | |
|---|---|---|
| Content Exports API | Export Content Endpoint | Added select parameter |
| External Tools API | Create an External Tool Endpoint | Added account_navigation[display_type] parameter |
| Grade Passback External Tools | Added Submission Details Return Extension documentation, which includes information about supporting Submitted At timestamps | Submissions API | Submission Summary Endpoint | Added grouped parameter | Users API | Create a User endpoint | Added destination parameter |
2018-05-12
Changes
| API Calls | Function | |
|---|---|---|
| Accounts API | List Active Courses in an Account endpoint | sort parameter: replaced subaccount value with account_name value. Subaccount can still be used as a value for backward compatibility. |
| User Observees API | List Observees endpoint | Clarifies that the returned observees will include the observation_link_root_account_ids attribute |
Additions
| API Calls | Function | |
|---|---|---|
| Accounts API | List Active Courses in an Account endpoint | Include parameter: Added account_name value |
| Communication Channels API | Delete a Push Notification endpoint | Added endpoint |
| Courses API | List Your Courses endpoint List Courses for a User endpoint Get a Single Course endpoint |
include parameter: Added account object |
| Enrollments API | List Enrollments endpoint | Added enrollment_term_id parameter |
| Submissions API | List Submissions for Multiple Assignments endpoint | Added graded_since parameter | Users API | Create a User endpoint | Added destination parameter |
| User Observees API | Add an Observee with Credentials endpoint Add an Observee endpoint Remove an Observee endpoint |
Added root_account_id parameter |
2018-04-21
Changes
| API Calls | Function | |
|---|---|---|
| Courses API | Permissions endpoint | Includes link to Accounts API Permissions endpoint Clarifies that permission names are documented in the Create a Role endpoint |
| Sections API | Create Course Section endpoint | Course_section[sis_section_id] parameter: Notes the user must have the manage_sis permissions to set |
Additions
| API Calls | Function | |
|---|---|---|
| Accounts API | Permissions endpoint | New endpoint: GET /api/v1/accounts/:account_id/permissions |
| Discussion Topics API | Get a Single Topic endpoint List Discussion Topics endpoint |
Added include parameter Added overrides as an allowed value in the include parameter |
| Sections API | Create Course Section endpoint | course_section[integration_id] parameter: sets the integration_id of the section |
| SIS CSV Format | changes_sis_id.csv | Added group_category as a type old_integration_id field: description clarifies that this field does not support group categories new_integration_id field: description clarifies that this field does not support group categories |
| SIS Imports API | Import SIS Data endpoint | skip_deletes parameter: can be used on any type of SIS import; when set, the import will skip any deletes |
| Users API | Get a Pandata JWT Token and its Expiration Date endpoint | Returns a jwt token, which can be used to send events to Canvas Data |
| API Responses | Function | |
|---|---|---|
| Modules API | Module object ModuleItem SequenceNode object ModuleItemSequence object |
Returns the published parameter Returns the mastery_path parameter and includes examples for the current and next items in the course Returns full examples for items and modules arrays |
| SIS Import Errors API | Get SIS Import Error List endpoint | Returns a list of SIS import errors for an account or SIS import |
| SIS Imports API | SISImport object | workflow_state parameter: returns whether the SIS import was aborted skip_deletes parameter: returns whether the import skipped any deleted objects |