🚀 Heads up: Our API Docs Have Moved!
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.
SIS Import Errors API
A SisImportError object looks like:
{
// The unique identifier for the SIS import.
"sis_import_id": 1,
// The file where the error message occurred.
"file": "courses.csv",
// The error message that from the record.
"message": "No short_name given for course C001",
// The contents of the line that had the error.
"row_info": "account_1, Sub account 1,, active ",
// The line number where the error occurred. Some Importers do not yet support
// this. This is a 1 based index starting with the header row.
"row": 34
}
Get SIS import error list SisImportErrorsApiController#index
GET /api/v1/accounts/:account_id/sis_imports/:id/errors
Scope:
url:GET|/api/v1/accounts/:account_id/sis_imports/:id/errors
GET /api/v1/accounts/:account_id/sis_import_errors
Scope:
url:GET|/api/v1/accounts/:account_id/sis_import_errors
GET /courses/:course_id/files/:file_id/download
Scope:
url:GET|/courses/:course_id/files/:file_id/download
GET /courses/:course_id/files/:file_id/download.:type
Scope:
url:GET|/courses/:course_id/files/:file_id/download
GET /courses/:course_id/files/:file_id/preview
Scope:
url:GET|/courses/:course_id/files/:file_id/preview
GET /quiz_statistics/:quiz_statistics_id/files/:file_id/download
Scope:
url:GET|/quiz_statistics/:quiz_statistics_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/download
Scope:
url:GET|/assessment_questions/:assessment_question_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/download.:type
Scope:
url:GET|/assessment_questions/:assessment_question_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/preview
Scope:
url:GET|/assessment_questions/:assessment_question_id/files/:file_id/preview
GET /groups/:group_id/files/:file_id/download
Scope:
url:GET|/groups/:group_id/files/:file_id/download
GET /groups/:group_id/files/:file_id/download.:type
Scope:
url:GET|/groups/:group_id/files/:file_id/download
GET /groups/:group_id/files/:file_id/preview
Scope:
url:GET|/groups/:group_id/files/:file_id/preview
GET /accounts/:account_id/files/:file_id/download
Scope:
url:GET|/accounts/:account_id/files/:file_id/download
GET /accounts/:account_id/files/:file_id/download.:type
Scope:
url:GET|/accounts/:account_id/files/:file_id/download
GET /accounts/:account_id/files/:file_id/preview
Scope:
url:GET|/accounts/:account_id/files/:file_id/preview
GET /users/:user_id/files/:file_id/download
Scope:
url:GET|/users/:user_id/files/:file_id/download
GET /users/:user_id/files/:file_id/download.:type
Scope:
url:GET|/users/:user_id/files/:file_id/download
GET /users/:user_id/files/:file_id/preview
Scope:
url:GET|/users/:user_id/files/:file_id/preview
GET /assignments/:assignment_id/files/:id/download
Scope:
url:GET|/assignments/:assignment_id/files/:id/download
GET /files/:file_id/download
Scope:
url:GET|/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
Scope:
url:GET|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download.:type
Scope:
url:GET|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/preview
Scope:
url:GET|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/preview
Returns the list of SIS import errors for an account or a SIS import. Import errors are only stored for 30 days.
Example:
curl 'https://<canvas>/api/v1/accounts/<account_id>/sis_imports/<id>/sis_import_errors' \
-H "Authorization: Bearer <token>"
Example:
curl 'https://<canvas>/api/v1/accounts/<account_id>/sis_import_errors' \
-H "Authorization: Bearer <token>"
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| failure | boolean |
If set, only shows errors on a sis import that would cause a failure. |