---
title: "Get Career Planner Role"
method: GET
path: "/api/v2/careerhub/career-planner/{userEmail}/roles/{roleSection}"
tags: ["Careerhub"]
---

# Get Career Planner Role

`GET /api/v2/careerhub/career-planner/{userEmail}/roles/{roleSection}`

## Request

- Base URL: `https://apiv2.eightfold.ai`
- URL: `https://apiv2.eightfold.ai/api/v2/careerhub/career-planner/{userEmail}/roles/{roleSection}`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/eightfold/apis/api-server-v2-service-service/docs/api/v2/careerhub/career-planner/:userEmail/roles/:roleSection/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns roles for a specified section. Possible values of sections are preferred-roles and recommended-roles

## Path parameters

- `userEmail` string, required
- `roleSection` string, required

## Query parameters

- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` CareerPlannerRoleSchema[]
    - `role` string, nullable, required: A name of the role such as Software Engineer
    - `salary` CareerPlannerSalarySchema
      - `count` integer, nullable: The number of salary reported
      - `value` integer, nullable: Salary value
    - `isTrending` boolean, nullable: A flag indicating that the role is trending
  - `meta` MetaSchema
    - `totalCount` integer, nullable
    - `pageTotalCount` integer, nullable
    - `pageStartIndex` integer, nullable

## Changes

- **2026-11-03** `9a8b3a927e93`: 1 breaking, 2 warning, 2 info
  - removed the required property `role` from the response with the `200` status
  - removed the optional property `isTrending` from the response with the `200` status
  - removed the optional property `salary` from the response with the `200` status
  - added the optional property `data` to the response with the `200` status
  - …1 more

[Operation history](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/changes/api/v2/careerhub/career-planner/:userEmail/roles/:roleSection/get.md)

---

[API](https://skmtc.dev/eightfold/apis/api-server-v2-service-service.md) - [All operations](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/llms.txt) - [OpenAPI document](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/revisions/9a8b3a927e93?raw)