> 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_experiences.md).

# Canvas Career Experiences

API for managing user career experience and role preferences in Canvas.

#### An ExperienceSummary object looks like: <a href="#experiencesummary" id="experiencesummary"></a>

```js
{
  // The current active experience. One of: 'academic', 'career_learner',
  // 'career_learning_provider'.
  "current_app": "career_learner",
  // List of available experiences for the user. Can include: 'academic',
  // 'career_learner', 'career_learning_provider'.
  "available_apps": ["academic", "career_learner"]
}
```

## [Check if Canvas Career is enabled](#method.career_experience.enabled) <a href="#method.career_experience.enabled" id="method.career_experience.enabled"></a>

[CareerExperienceController#enabled](https://github.com/instructure/canvas-lms/blob/master/app/controllers/career_experience_controller.rb)

#### `GET /api/v1/career/enabled`

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

Returns whether the root account has Canvas Career (Horizon) enabled in at least one subaccount.

#### Example Request:

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

#### Example Response:

```js
{"enabled": true}
```

## [Get current and available experiences](#method.career_experience.experience_summary) <a href="#method.career_experience.experience_summary" id="method.career_experience.experience_summary"></a>

[CareerExperienceController#experience\_summary](https://github.com/instructure/canvas-lms/blob/master/app/controllers/career_experience_controller.rb)

#### `GET /api/v1/career/experience_summary`

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

Returns the current user's active experience and available experiences they can switch to.

#### Example Request:

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

Returns an [ExperienceSummary](#experiencesummary) object.

## [Switch experience](#method.career_experience.switch_experience) <a href="#method.career_experience.switch_experience" id="method.career_experience.switch_experience"></a>

[CareerExperienceController#switch\_experience](https://github.com/instructure/canvas-lms/blob/master/app/controllers/career_experience_controller.rb)

#### `POST /api/v1/career/switch_experience`

**Scope:** `url:POST|/api/v1/career/switch_experience`

Switch the current user's active experience to the specified one.

#### Request Parameters:

| Parameter    | Type              | Description                                                       |
| ------------ | ----------------- | ----------------------------------------------------------------- |
| `experience` | Required `string` | The experience to switch to. Allowed values: `academic`, `career` |

#### Example Request:

```bash
curl -X POST https://<canvas>/api/v1/career/switch_experience \
  -H 'Authorization: Bearer <token>' \
  -d 'experience=academic'
```

## [Switch role](#method.career_experience.switch_role) <a href="#method.career_experience.switch_role" id="method.career_experience.switch_role"></a>

[CareerExperienceController#switch\_role](https://github.com/instructure/canvas-lms/blob/master/app/controllers/career_experience_controller.rb)

#### `POST /api/v1/career/switch_role`

**Scope:** `url:POST|/api/v1/career/switch_role`

Switch the current user's Career role. Every role is a Career role, so this also sets the user's preferred experience to career.

#### Request Parameters:

| Parameter | Type              | Description                                                           |
| --------- | ----------------- | --------------------------------------------------------------------- |
| `role`    | Required `string` | The role to switch to. Allowed values: `learner`, `learning_provider` |

#### Example Request:

```bash
curl -X POST https://<canvas>/api/v1/career/switch_role \
  -H 'Authorization: Bearer <token>' \
  -d 'role=learner'
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.