Career Path

SkyHive’s Career Path API lets you manage employee skills and can assist with upskilling and reskilling employees. With this API, you can:

  • Discover jobs requiring similar skills
  • Retrieve skills for a job title
  • Compare skill sets to identify skill matches and gaps

Career Path API Methods

You can compare and search for existing skills using these methods:

Compare Skills

The compareSkills method compares two arrays of skills:

  1. The “from” array holds skills currently associated with an employee, job, or course.
  2. The “to” array holds the skills of a desired title or job.

The compareSkills method returns an array of matching skills, an array of skills that are present in the “to” array but missing in the “from” array, and a score that indicates the quality of the match.

Use Cases

The following use case covers a possible application of the Career Path API:

Get Skills By Title

Get a list of skills for a specified job title.

Securityauth
Request
path Parameters
title
required
string

Specified job title

query Parameters
country
required
string

Country data to query (use two-letter ISO code)

trend
boolean
Default: false

Include trend when available

header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/careerpath/skills/{title}
Request samples

Get Similar Titles

Get a list of job titles similar to a specified one.

Securityauth
Request
query Parameters
title
required
string

Specified job title

country
required
string

Country data to query (use two-letter ISO code)

resultsPerPage
integer <int32>
Default: 10

Page size for paging

header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/careerpath/similar
Request samples

compareSkills

Securityauth
Request
query Parameters
to
boolean
Default: false

Reverses comparison order when true

algorithm
string
Default: "default"
header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
Array of objects (Skill-2) unique

Required skills and levels

Array of objects (Skill-2) unique

Skills being compared

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/careerpath/compare
Request samples
application/json
{
  • "from": [
    ],
  • "to": [
    ]
}
Response samples
application/json
{
  • "matchingSkills": [
    ],
  • "missingSkills": [
    ],
  • "quality": 0
}

Get SimilarTitle by JobTitleId

Get a similarTitles by using job titleId.

Securityauth
Request
path Parameters
titleId
required
string

Specified job titleId

query Parameters
size
integer
Default: 5
type
string
Default: "LevelUp"

Include transition type (e.g., LevelUp)

header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/careerpath/similarTitles/{titleId}
Request samples