🚀 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.
Accessibility Course Scans API
Get latest accessibility course scan AccessibilityCourseScansController#show
GET /api/v1/users/:user_id/educator_accessibility_course_scan
Scope:
Returns the most recent bulk accessibility scan Progress for this user,
whether it's still in progress or already finished -- null if the user
has never triggered a scan. Unlike the trigger endpoint, this never
starts a scan; it's safe to call just to check status (e.g. on page
load, to resume showing an in-progress scan or to know when the last
one finished).
Requires the educator_dashboard feature flag on the root account and
a11y_checker_account_statistics on site admin.
url:GET|/api/v1/users/:user_id/educator_accessibility_course_scan
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| user_id | Required | string | The ID of the user, or "self" for the current user. The requesting user may only view their own scan status. |
Trigger accessibility course scan AccessibilityCourseScansController#create
POST /api/v1/users/:user_id/educator_accessibility_course_scan
Scope:
Queues a background job that scans all a11y-enabled courses where the
user has an active teacher or designer enrollment. Idempotent — if a
scan is already queued or running, the existing Progress is returned.
Requires the educator_dashboard feature flag on the root account and
a11y_checker_account_statistics on site admin.
url:POST|/api/v1/users/:user_id/educator_accessibility_course_scan
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| user_id | Required | string | The ID of the user, or "self" for the current user. The requesting user may only trigger a scan for themselves. |