v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Careerhub

Get Career Planner Role

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

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

Path parameters

userEmailstring required

User Email

roleSectionstring required

Role section e.g. preferred-roles and recommended-roles

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

rolestring nullable required

A name of the role such as Software Engineer

isTrendingboolean nullable

A flag indicating that the role is trending