> For the complete documentation index, see [llms.txt](https://developerdocs.instructure.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developerdocs.instructure.com/services/canvas/resources/canvas_career_user_context.md).

# Canvas Career User Context

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: <a href="#careerusercontext" id="careerusercontext"></a>

```js
{
  // 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](#method.career_user_context.show) <a href="#method.career_user_context.show" id="method.career_user_context.show"></a>

[CareerUserContextController#show](https://github.com/instructure/canvas-lms/blob/master/app/controllers/career_user_context_controller.rb)

#### `GET /api/v1/career/user_context`

**Scope:** `url:GET|/api/v1/career/user_context`

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.

#### Request Parameters:

| Parameter    | Type     | Description                                                                                                                                                                                                                                     |
| ------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | `string` | <p>Canvas account ID for permission and subaccount admin checks. Defaults<br>to the domain root account ("self"). Other fields (experience,<br>enrollment\_types, admin\_roles, is\_site\_admin) always resolve against<br>the domain root.</p> |

#### Example Request:

```bash
curl https://<canvas>/api/v1/career/user_context \
  -H 'Authorization: Bearer <token>'
```

#### Example Response:

```js
{
  "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
}
```

Returns a [CareerUserContext](#careerusercontext) object.

***

This documentation is generated directly from the Canvas LMS source code, available [on Github](https://github.com/instructure/canvas-lms).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developerdocs.instructure.com/services/canvas/resources/canvas_career_user_context.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.