Employees

SkyHive’s Employees API lets you manage employee profiles and match employees to jobs. With this API, you can:

  • Access and update collected employee information
  • Match candidates to a job or search for candidates

Employees API Methods

You can create, read, update, or delete employee information using these methods:

An employee ID is a required parameter when invoking getEmployee, updateEmployee, and deleteEmployee. See below for more information.

You can search for employees and match employee skill sets to a job’s required skill sets using these methods:

Employee ID

Employees are referenced by ID, which are created and returned by createEmployee.

Match Employee to Job

The matchEmployeeToJob method compares the following:

  1. An array that contains an individual employee’s skill set.
  2. An array of skills that are either required or optional for the job.

The matchEmployeeToJob method returns the following:

  1. “Normal” information, including:
  • An array of currently matching skills.
  • An array of the job skills that the employee currently lacks.
  • A score that indicates the quality of the current match.
  1. “Desired” information, including:
  • An array of the ideal matching skills.
  • An array of the ideal missing skills.
  • A score that indicates the quality of the ideal match.

Use Cases

These use cases cover possible applications of the Employee API:

Use Case: Creating Employee Profiles

Use Case: Visualizing Employee Career Paths

Use Case: Deciding Whether to Recruit Internally or Externally

Create Employee

Create a new Employee object to add a new employee to your organization.

Securityauth
Request
header Parameters
X-Enterprise-Id
required
string

The unique ID assigned to your organization

Request Body schema: application/json
required
required
object (Name)

Contains employee name

required
object (AccountInformation)

Contains employee email

required
object (JobTitle)

Contains employee job information

required
object (Location)
Array of objects (Skill) unique

Array of employee skills

Array of objects (Experience)

Array of employee experiences

Array of objects (Study)

Array of employee studies

expYears
number <double>

Total Years of experience

Array of objects (CoursesOrCertificates)

Array of employee courses and certificates

licenses
Array of objects

Array of employee licenses (any object)

patents
Array of strings

Array of employee patents

publications
Array of strings

Array of employee publications

Array of objects (Hobby)

Array of employee hobbies

sponsorshipCountries
Array of strings unique

Array of countries that require employment sponsorship

object (Preferences)

Contains employee job preferences

Array of objects (Location)

Array of desired job locations

Array of objects (JobTitle)

Array of desired job titles

Array of objects (Skill) unique

Array of desired skills

desiredCompany
Array of strings

Array of desired companies (maximum of 3)

Array of objects (TrainingDTO)

Array of employee completed trainings

dateStarted
string <date-time>

Start date

dateCompleted
string <date-time>

End date

tags
Array of strings unique

Employee tags

entityStatus
string

Contains employee status details

Enum: "none" "active" "archived"
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/employees
Request samples
application/json
{
  • "name": {
    },
  • "accountInformation": {},
  • "jobTitle": {
    },
  • "location": {
    },
  • "skills": [
    ],
  • "experience": [
    ],
  • "studies": [
    ],
  • "expYears": 0,
  • "coursesOrCertificates": [
    ],
  • "licenses": [
    ],
  • "patents": [
    ],
  • "publications": [
    ],
  • "hobbies": [
    ],
  • "sponsorshipCountries": [
    ],
  • "preferences": {
    },
  • "desiredLocation": [
    ],
  • "desiredJobTitles": [
    ],
  • "desiredSkills": [
    ],
  • "desiredCompany": [
    ],
  • "trainings": [
    ],
  • "dateStarted": "2019-08-24T14:15:22Z",
  • "dateCompleted": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "entityStatus": "none"
}
Response samples
application/json
{
  • "employeeId": "string",
  • "name": {
    },
  • "accountInformation": {},
  • "jobTitle": {
    },
  • "location": {
    },
  • "skills": [
    ],
  • "experience": [
    ],
  • "studies": [
    ],
  • "expYears": 0,
  • "coursesOrCertificates": [
    ],
  • "licenses": [
    ],
  • "patents": [
    ],
  • "publications": [
    ],
  • "hobbies": [
    ],
  • "sponsorshipCountries": [
    ],
  • "preferences": {
    },
  • "desiredLocation": [
    ],
  • "desiredJobTitles": [
    ],
  • "desiredSkills": [
    ],
  • "desiredCompany": [
    ],
  • "trainings": [
    ],
  • "dateStarted": "2019-08-24T14:15:22Z",
  • "dateCompleted": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "avatar": {
    },
  • "enterpriseId": "string",
  • "metadata": {
    },
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "visibility": [
    ],
  • "originalId": "string",
  • "entityStatus": "none",
  • "referenceId": "string"
}

Get Employee By Email

Get the Employee object to view details (e.g. name, job title, and skills).

Securityauth
Request
query Parameters
email
required
string
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/employees
Request samples

Get Employee

Get the Employee object to view details (e.g. name, job title, and skills).

Securityauth
Request
path Parameters
id
required
string

The employee's unique ID

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/employees/{id}
Request samples

Update Employee

Update the Employee object to edit details (e.g. job title, skills, and completed trainings).

Securityauth
Request
path Parameters
id
required
string

The employee's unique ID

header Parameters
X-Enterprise-Id
required
string

The unique ID assigned to your organization

Request Body schema: application/json
required
required
object (Name)

Contains employee name

required
object (AccountInformation)

Contains employee email

required
object (JobTitle)

Contains employee job information

required
object (Location)
Array of objects (Skill) unique

Array of employee skills

Array of objects (Experience)

Array of employee experiences

Array of objects (Study)

Array of employee studies

expYears
number <double>

Total Years of experience

Array of objects (CoursesOrCertificates)

Array of employee courses and certificates

licenses
Array of objects

Array of employee licenses (any object)

patents
Array of strings

Array of employee patents

publications
Array of strings

Array of employee publications

Array of objects (Hobby)

Array of employee hobbies

sponsorshipCountries
Array of strings unique

Array of countries that require employment sponsorship

object (Preferences)

Contains employee job preferences

Array of objects (Location)

Array of desired job locations

Array of objects (JobTitle)

Array of desired job titles

Array of objects (Skill) unique

Array of desired skills

desiredCompany
Array of strings

Array of desired companies (maximum of 3)

Array of objects (TrainingDTO)

Array of employee completed trainings

dateStarted
string <date-time>

Start date

dateCompleted
string <date-time>

End date

tags
Array of strings unique

Employee tags

entityStatus
string

Contains employee status details

Enum: "none" "active" "archived"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/employees/{id}
Request samples
application/json
{
  • "name": {
    },
  • "accountInformation": {},
  • "jobTitle": {
    },
  • "location": {
    },
  • "skills": [
    ],
  • "experience": [
    ],
  • "studies": [
    ],
  • "expYears": 0,
  • "coursesOrCertificates": [
    ],
  • "licenses": [
    ],
  • "patents": [
    ],
  • "publications": [
    ],
  • "hobbies": [
    ],
  • "sponsorshipCountries": [
    ],
  • "preferences": {
    },
  • "desiredLocation": [
    ],
  • "desiredJobTitles": [
    ],
  • "desiredSkills": [
    ],
  • "desiredCompany": [
    ],
  • "trainings": [
    ],
  • "dateStarted": "2019-08-24T14:15:22Z",
  • "dateCompleted": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "entityStatus": "none"
}
Response samples
application/json
{
  • "employeeId": "string",
  • "name": {
    },
  • "accountInformation": {},
  • "jobTitle": {
    },
  • "location": {
    },
  • "skills": [
    ],
  • "experience": [
    ],
  • "studies": [
    ],
  • "expYears": 0,
  • "coursesOrCertificates": [
    ],
  • "licenses": [
    ],
  • "patents": [
    ],
  • "publications": [
    ],
  • "hobbies": [
    ],
  • "sponsorshipCountries": [
    ],
  • "preferences": {
    },
  • "desiredLocation": [
    ],
  • "desiredJobTitles": [
    ],
  • "desiredSkills": [
    ],
  • "desiredCompany": [
    ],
  • "trainings": [
    ],
  • "dateStarted": "2019-08-24T14:15:22Z",
  • "dateCompleted": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "avatar": {
    },
  • "enterpriseId": "string",
  • "metadata": {
    },
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "visibility": [
    ],
  • "originalId": "string",
  • "entityStatus": "none",
  • "referenceId": "string"
}

Patch Employee

Patch the Employee object to edit details (e.g. job title, skills, and completed trainings).

Securityauth
Request
path Parameters
id
required
string

The employee's unique ID

header Parameters
X-Enterprise-Id
required
string

The unique ID assigned to your organization

Request Body schema: application/json
required
Array
op
string

Use enum values to specify patch operation

Enum: "add" "remove" "replace"
path
string
value
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/employees/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "employeeId": "string",
  • "name": {
    },
  • "accountInformation": {},
  • "jobTitle": {
    },
  • "location": {
    },
  • "skills": [
    ],
  • "experience": [
    ],
  • "studies": [
    ],
  • "expYears": 0,
  • "coursesOrCertificates": [
    ],
  • "licenses": [
    ],
  • "patents": [
    ],
  • "publications": [
    ],
  • "hobbies": [
    ],
  • "sponsorshipCountries": [
    ],
  • "preferences": {
    },
  • "desiredLocation": [
    ],
  • "desiredJobTitles": [
    ],
  • "desiredSkills": [
    ],
  • "desiredCompany": [
    ],
  • "trainings": [
    ],
  • "dateStarted": "2019-08-24T14:15:22Z",
  • "dateCompleted": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "avatar": {
    },
  • "enterpriseId": "string",
  • "metadata": {
    },
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "visibility": [
    ],
  • "originalId": "string",
  • "entityStatus": "none",
  • "referenceId": "string"
}

Delete Employee

Delete the Employee object to remove an employee from your organization.

Securityauth
Request
path Parameters
id
required
string

The employee's unique ID

header Parameters
X-Enterprise-Id
required
string
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/employees/{id}
Request samples

Match Employee to Job

Match Employee to Job compares an employee to a job and returns a quality score. The job is the basis for comparison. The quality score reflects how well the employee satisfies the requirements of the job. The config object in the request body determines how the quality score is calculated. The primary basis for the quality calculation is skills but location can also be used. The default algorithm considers the required skill level in the comparison. However, the job skills typically have a default value of “experienced”, especially external jobs that were parsed from job sites. In this case, it may be more appropriate to use the “basic” algorithm that avoids the quality penalty for employee skills that are generally lower than the default “experienced” level. Many of the settings in the config object are useful as filters on a search and not in this match context.

This API has some value in a use case where a user is browsing the result set of a general job search, for example, and wants to see the quality score for their own employee profile compared to a job. The flow could be like this:

  1. Employee searches for product manager jobs in San Francisco.
  2. Employee sees a job that looks interesting and clicks to view details.
  3. Details page displays comparison of Employee to job along with a quality score.

This search is similar to Search Jobs by Employee ID but allows for an unconstrained initial search, without sorting by quality or location.

Securityauth
Request
path Parameters
empId
required
string
jobId
required
string
header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
object (SearchConfig)

Employment search config params use only algorithm

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/employees/{empId}/job/{jobId}
Request samples
application/json
{
  • "config": {
    }
}
Response samples
application/json
{
  • "normal": {
    },
  • "desired": {
    }
}

Search Employees

Search across internal and external employees using a variety of parameters. Internal employees are the records a PaaS user has added to their instance. External employees are the hundreds of millions professional profiles that come from Internet sites like LinkedIn, Indeed, and Ziprecruiter.

The search parameter “includeExternal” determines whether external employees are searched as well as internal. The “config” object in the request body controls how the search works and how the quality score is calculated. The search may include “title”, “location”, “skills”, “tags”, and other criteria. When “location” and “skills” are true, which is the default, they are used to calculate the quality score. When a search includes “location”, the “location” object is used to obtain the latitude and longitude from a geocoding service. During search, the location is compared to each employee’s location to determine the distance. When the distance is greater than the radius defined in the location object a penalty is applied to the quality score.

The skills defined in the request body are compared against the skills of every employee to determine the quality score. The default “algorithm” also compares the skill level of each skill. When the employee’s skill level is lower than the required skill level of the search a penalty is applied to the quality score. External employees have a default skill level of “experienced” and do not incur a penalty to the quality score when the search uses the default algorithm. Internal employees likely have skills at different skill levels. When searching across internal and external employees using skills, external employees have higher quality scores. To avoid this situation, the “basic” skill algorithm can be used, which ignores skill level in the comparison and calculation of the quality score.

Securityauth
Request
header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
resultsPerPage
integer <int32> [ 1 .. 100 ]
Default: 10

Specifies the number of results to be returned

page
integer <int32> >= 0
Default: 0

Specifies the page number

Array of objects (Skill)

Skills that are needed to be searched for

minExperience
number <double>

Minimum Employee experience in years

jobIds
Array of strings

Job Id's of the employees to search for

jobTitles
Array of strings

Job Titles of the employees to search for

current
boolean
Default: true

current represents the Current Job Titles if not it will look for any job titles

hiredFrom
string <date-time>

Employees Hired from date

hiredTo
string <date-time>

Employees Hired till date

degree
string

Degree filter for an employee

country
string

Country code to look for employees

object (LocationRequest)

Location information to search for the employee

object (CompanyDetails)

Company details to look for in an employee

desiredJobTitles
Array of strings

Desired Job Titles of the employees to search for

university
string

Employee Studied University name

visibility
Array of strings unique

visibility to be filtered for the Employee

tags
Array of strings unique

Tags to be filtered for the Employee

sortBy
string

Results to be sorted based on this field value

Enum: "quality" "location" "startDate" "nameAsc" "nameDesc" "sourceAsc" "sourceDesc"
minMatchPercentage
number <float> [ 1 .. 100 ]
Default: 20

Minimum match percentage

sponsorshipCountries
Array of strings unique

Employment sponsorship required countries

object (SearchConfig)

Employment search config params use only algorithm

includeExternal
boolean
Default: false

Include external employees as well in search

source
Array of strings unique

List of source to be included in the search

sourcesEnum
Array of strings unique

List of sources to be included in the search. May include one or more enum values.

Items Enum: "linkedin" "bayt" "postjobfree" "indeed" "ziprecruiter" "trudvsem" "tanqeeb" "bebee"
entityStatus
string

List of enums to be included in the search

Enum: "none" "active" "archived"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/employees/search
Request samples
application/json
{
  • "resultsPerPage": 10,
  • "page": 0,
  • "skills": [
    ],
  • "minExperience": 0,
  • "jobIds": [
    ],
  • "jobTitles": [
    ],
  • "current": true,
  • "hiredFrom": "2019-08-24T14:15:22Z",
  • "hiredTo": "2019-08-24T14:15:22Z",
  • "degree": "string",
  • "country": "string",
  • "location": {
    },
  • "companyDetails": {
    },
  • "desiredJobTitles": [
    ],
  • "university": "string",
  • "visibility": [
    ],
  • "tags": [
    ],
  • "sortBy": "quality",
  • "minMatchPercentage": 20,
  • "sponsorshipCountries": [
    ],
  • "config": {
    },
  • "includeExternal": false,
  • "source": [
    ],
  • "sourcesEnum": [
    ],
  • "entityStatus": "none"
}
Response samples
application/json
{
  • "total": 0,
  • "employeeId": "string",
  • "name": {
    },
  • "accountInformation": {},
  • "jobTitle": {
    },
  • "location": {
    },
  • "skills": [
    ],
  • "experience": [
    ],
  • "studies": [
    ],
  • "expYears": 0,
  • "coursesOrCertificates": [
    ],
  • "licenses": [
    ],
  • "patents": [
    ],
  • "publications": [
    ],
  • "hobbies": [
    ],
  • "sponsorshipCountries": [
    ],
  • "preferences": {
    },
  • "desiredLocation": [
    ],
  • "desiredJobTitles": [
    ],
  • "desiredSkills": [
    ],
  • "desiredCompany": [
    ],
  • "trainings": [
    ],
  • "dateStarted": "2019-08-24T14:15:22Z",
  • "dateCompleted": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "avatar": {
    },
  • "enterpriseId": "string",
  • "metadata": {
    },
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "visibility": [
    ],
  • "originalId": "string",
  • "entityStatus": "none",
  • "referenceId": "string",
  • "quality": 0,
  • "breakdown": {
    },
  • "sourceId": "string",
  • "source": "string",
  • "sourceUri": "string",
  • "locationPoint": {
    }
}

Search Employees By JobID

Securityauth
Request
path Parameters
id
required
string
header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
resultsPerPage
integer <int32> [ 1 .. 100 ]
Default: 10

Specifies the number of results to be returned

page
integer <int32> >= 0
Default: 0

Specifies the page number

minMatchPercentage
number <float> [ 1 .. 100 ]
Default: 20

Minimum match percentage

includeExternal
boolean
Default: false

Include external employees as well in search

radius
integer <int32> >= 0
Default: 20

Radius from the Job location

object (SearchConfig)

Employment search config params use only algorithm

ignoreLocation
boolean
Default: false

Duplicate of config.location use config.location cause this ignoreLocation is deprecated

sortBy
string

Results to be sorted based on this field value

Enum: "quality" "location" "startDate" "nameAsc" "nameDesc" "sourceAsc" "sourceDesc"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/employees/search/{id}
Request samples
application/json
{
  • "resultsPerPage": 10,
  • "page": 0,
  • "minMatchPercentage": 20,
  • "includeExternal": false,
  • "radius": 20,
  • "config": {
    },
  • "ignoreLocation": false,
  • "sortBy": "quality"
}
Response samples
application/json
{
  • "total": 0,
  • "employeeId": "string",
  • "name": {
    },
  • "accountInformation": {},
  • "jobTitle": {
    },
  • "location": {
    },
  • "skills": [
    ],
  • "experience": [
    ],
  • "studies": [
    ],
  • "expYears": 0,
  • "coursesOrCertificates": [
    ],
  • "licenses": [
    ],
  • "patents": [
    ],
  • "publications": [
    ],
  • "hobbies": [
    ],
  • "sponsorshipCountries": [
    ],
  • "preferences": {
    },
  • "desiredLocation": [
    ],
  • "desiredJobTitles": [
    ],
  • "desiredSkills": [
    ],
  • "desiredCompany": [
    ],
  • "trainings": [
    ],
  • "dateStarted": "2019-08-24T14:15:22Z",
  • "dateCompleted": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "avatar": {
    },
  • "enterpriseId": "string",
  • "metadata": {
    },
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "visibility": [
    ],
  • "originalId": "string",
  • "entityStatus": "none",
  • "referenceId": "string",
  • "quality": 0,
  • "breakdown": {
    },
  • "sourceId": "string",
  • "source": "string",
  • "sourceUri": "string",
  • "locationPoint": {
    }
}

Search External Employees

Securityauth
Request
header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
resultsPerPage
integer <int32> [ 1 .. 100 ]
Default: 10

Specifies the number of results to be returned

page
integer <int32> >= 0
Default: 0

Specifies the page number

Array of objects (Skill)

Skills that are needed to be searched for

minExperience
number <double>

Minimum Employee experience in years

jobIds
Array of strings

Job Id's of the employees to search for

jobTitles
Array of strings

Job Titles of the employees to search for

current
boolean
Default: true

current represents the Current Job Titles if not it will look for any job titles

hiredFrom
string <date-time>

Employees Hired from date

hiredTo
string <date-time>

Employees Hired till date

degree
string

Degree filter for an employee

country
string

Country code to look for employees

object (LocationRequest)

Location information to search for the employee

object (CompanyDetails)

Company details to look for in an employee

desiredJobTitles
Array of strings

Desired Job Titles of the employees to search for

university
string

Employee Studied University name

visibility
Array of strings unique

visibility to be filtered for the Employee

tags
Array of strings unique

Tags to be filtered for the Employee

sortBy
string

Results to be sorted based on this field value

Enum: "quality" "location" "startDate" "nameAsc" "nameDesc" "sourceAsc" "sourceDesc"
minMatchPercentage
number <float> [ 1 .. 100 ]
Default: 20

Minimum match percentage

sponsorshipCountries
Array of strings unique

Employment sponsorship required countries

object (SearchConfig)

Employment search config params use only algorithm

includeExternal
boolean
Default: false

Include external employees as well in search

source
Array of strings unique

List of source to be included in the search

sourcesEnum
Array of strings unique

List of sources to be included in the search. May include one or more enum values.

Items Enum: "linkedin" "bayt" "postjobfree" "indeed" "ziprecruiter" "trudvsem" "tanqeeb" "bebee"
entityStatus
string

List of enums to be included in the search

Enum: "none" "active" "archived"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/employees/external/search
Request samples
application/json
{
  • "resultsPerPage": 10,
  • "page": 0,
  • "skills": [
    ],
  • "minExperience": 0,
  • "jobIds": [
    ],
  • "jobTitles": [
    ],
  • "current": true,
  • "hiredFrom": "2019-08-24T14:15:22Z",
  • "hiredTo": "2019-08-24T14:15:22Z",
  • "degree": "string",
  • "country": "string",
  • "location": {
    },
  • "companyDetails": {
    },
  • "desiredJobTitles": [
    ],
  • "university": "string",
  • "visibility": [
    ],
  • "tags": [
    ],
  • "sortBy": "quality",
  • "minMatchPercentage": 20,
  • "sponsorshipCountries": [
    ],
  • "config": {
    },
  • "includeExternal": false,
  • "source": [
    ],
  • "sourcesEnum": [
    ],
  • "entityStatus": "none"
}
Response samples
application/json
{
  • "total": 0,
  • "employeeId": "string",
  • "name": {
    },
  • "accountInformation": {},
  • "jobTitle": {
    },
  • "location": {
    },
  • "skills": [
    ],
  • "experience": [
    ],
  • "studies": [
    ],
  • "expYears": 0,
  • "coursesOrCertificates": [
    ],
  • "licenses": [
    ],
  • "patents": [
    ],
  • "publications": [
    ],
  • "hobbies": [
    ],
  • "sponsorshipCountries": [
    ],
  • "preferences": {
    },
  • "desiredLocation": [
    ],
  • "desiredJobTitles": [
    ],
  • "desiredSkills": [
    ],
  • "desiredCompany": [
    ],
  • "trainings": [
    ],
  • "dateStarted": "2019-08-24T14:15:22Z",
  • "dateCompleted": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "avatar": {
    },
  • "enterpriseId": "string",
  • "metadata": {
    },
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "visibility": [
    ],
  • "originalId": "string",
  • "entityStatus": "none",
  • "referenceId": "string",
  • "quality": 0,
  • "breakdown": {
    },
  • "sourceId": "string",
  • "source": "string",
  • "sourceUri": "string",
  • "locationPoint": {
    }
}

Get Employee External With Score

Get the Employee object to view details (e.g. name, job title, and skills).

Securityauth
Request
path Parameters
id
required
string

The employee's unique ID

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/external/{id}
Request samples

Update Training of an Employee

Update Employee training object using employee and training IDs.

Securityauth
Request
path Parameters
empId
required
string

The employee unique ID

trainingId
required
string

The training unique ID

header Parameters
X-Enterprise-Id
required
string
Request Body schema: application/json
required
status
string
Enum: "inprogress" "completed"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/{empId}/training/{trainingId}
Request samples
application/json
{
  • "status": "inprogress"
}
Response samples
application/json
{
  • "id": [
    ],
  • "status": "inprogress"
}

Get Sources

Get the Candidate object to view details (e.g. name, job title, and skills).

Securityauth
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/source
Request samples

Match Employee to Position

Compare the skills of an employee to the skills required by a position. The “default” comparison algorithm considers skill level and penalizes a skill match at a lower competency. The “basic” algorithm ignores skill level and only penalizes missing skills in the quality score. The quality score indicates to what extent the employee meets the skill requirements for the position. When the “verbose” query parameter is true, the skill comparison results are broken down into topSkills, partialSkills, fromSkillsMissing, and toSkillsMissing.

Securityauth
Request
path Parameters
empId
required
string
posId
required
string
query Parameters
algorithm
string
Default: "default"
verbose
boolean
Default: false
to
boolean
Default: false
header Parameters
X-Enterprise-Id
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/{empId}/position/{posId}
Request samples
Response samples
application/json
{
  • "normal": {
    },
  • "desired": {
    },
  • "bNormal": {
    },
  • "bDesired": {
    }
}