🚀 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.
Canvas Career User Context API
Consolidated API for retrieving all user context data needed by Journey in a single request. Replaces separate calls to permissions, experience_summary, enrollments, and admin roles endpoints.
A CareerUserContext object looks like:
{
// Account permission checks for the authenticated user.
"permissions": null,
// Career experience summary including current app and available apps.
"experience": null,
// Distinct enrollment types for the user (active, invited, and pending).
"enrollment_types": null,
// Admin roles on the domain root account.
"admin_roles": null,
// Whether the user is a site admin.
"is_site_admin": null,
// Whether the user admins a subaccount under the domain root. When account_id
// is provided, true only if the user can admin that specific account.
"is_subaccount_admin": null,
// Whether the user is an admin on the domain root account or a site admin.
"is_root_account_admin": null
}Get career user context CareerUserContextController#show
GET /api/v1/career/user_context
Scope:
Returns consolidated user context data for Journey, combining account
permissions, career experience info, enrollment types, admin roles,
and site admin status in a single response.
url:GET|/api/v1/career/user_context
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| account_id | string | Canvas account ID for permission and subaccount admin checks. Defaults to the domain root account ("self"). Other fields (experience, enrollment_types, admin_roles, is_site_admin) always resolve against the domain root. |
Example Request:
curl https://<canvas>/api/v1/career/user_context \
-H 'Authorization: Bearer <token>'Example Response:
{
"permissions": {"manage": true, "manage_site_settings": false, ...},
"experience": {"current_app": "career_learner", "available_apps": ["career_learner"]},
"enrollment_types": ["StudentEnrollment", "TeacherEnrollment"],
"admin_roles": [{"role": "AccountAdmin"}],
"is_site_admin": false,
"is_subaccount_admin": false
}