Create Employee

post

https://apiv2.{domain}.ai/api/v2/core/employees

Creates a new employee

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

managerEmail

string | null

The email of the manager

location

string | null

The location of the employee

customInfo

object | null

The custom info captured for the employee by custom fields

employmentDates

array of objects | null

The typed lifecycle dates of the employee, keyed by type. A write replaces the whole list: send every date that should survive it. Send [] or null to clear all. Omit the field to leave the stored dates untouched.

employmentDates

systemId

string | null

Integration system id for the employee

languages

array of objects | null

The employee language proficiencies

languages

pronouns

string | null

Preferred pronouns of the employee

externalSystemIds

array of objects | null

The employee ids in systems outside the HRIS (payroll and the like). A write replaces the whole list: send every id that should survive it. Send [] or null to clear all. Omit the field to leave the stored ids untouched.

externalSystemIds

terminationRegrettable

string | null

Is the exit regrettable?

lastActivityTs

int32 | null

The last activity timestamp in seconds

terminationTs

int32 | null

The termination timestamp of the employee in seconds

jobCode

string | null

The job code of the employee

timezone

string | null

Working time zone

preferredFirstName

string | null

First name the employee goes by

role

string | null

The role of the employee

workplaceModel

string | null

Workplace model (office / hybrid / remote)

personalEmail

string | null

The personal email of the employee

isContingent

boolean | null

Is contingent

mobility

object | null

The mobility of the employee

string | null

The Business unit of the employee

temporalFields

array of objects

Temporal fields of the employee

temporalFields

rmUserGroups

array of objects | null

RM user groups associated with the employee

rmUserGroups

maritalStatus

string | null

Marital status of the employee

externalJobId

string | null

External job id of the employee

additionalManagers

array of objects | null

The additional managers of the employee. The list sent replaces the stored list; send an empty list to clear all, or omit to leave the existing managers unchanged.

additionalManagers

companyName

string | null

The company name of the employee

phone

string | null

The phone number of the employee

managerUserId

string | null

The user id of the manager in HRIS system

eligibleForTransfer

boolean | null

Is the employee eligible for transfer or not

lastName

string | null

Last Name of the employee

employeeType

string | null

Type of the employee

middleName

string | null

Middle name of the employee

employmentStatus

string | null

Current employment status

badges

array of objects | null

The badges of the employee

badges

firstName

string | null

First Name of the employee

basePay

object | null

The base pay of the employee

userId

string | null

The userId of the employee

businessEmail

string | null

The business email of the employee

lastReviewRating

string | null

The last review rating of the employee

employmentBasis

string | null

Employment basis (full-time / part-time)

successionPlan

object | null

On read: the ids linking this employee to /careerhub/succession_plans, i.e. the plan they are the incumbent of and the plans they are an active successor in. Null when in no plan. Covers position-based succession plans; tenants still on the legacy profile-based model mostly get null. On write: the HRIS succession plan for this employee.

bonus

object | null

The bonus given to the employee

managerFullname

string | null

The full name of the manager

rehireEligibility

string | null

Eligible for rehire?

userHighlightedSkills

array of strings | null

Skills the employee has highlighted on their Career Hub profile. A write replaces the whole list; an empty list clears it. Only skills already on the profile are returned, in the profile's own spelling.

userHighlightedSkills

locationCountry

string | null

The location country of the employee

candidateData

object | null

candidate data of employee

positionCriticality

array of strings | null

The criticality of the position of the employee

positionCriticality

string

required

List of Emails of the employee comma seperated

level

string | null

The job level of the employee

terminationType

string | null

Termination type (voluntary / involuntary)

employeeId

string

required

The unique id of the Employee in the HRIS system

employeeCriticality

object | null

The criticality information of the employee

performanceRatings

array of objects | null

Performance ratings for the employee

performanceRatings

title

string | null

The title of the employee

citizenship

array of strings | null

Citizenships of the employee, more than one when dual. A write replaces the whole list: send every citizenship that should survive it. Send [] or null to clear all. Omit the field to leave the stored citizenships untouched.

citizenship

preferredLastName

string | null

Last name the employee goes by

managerContactEmail

string | null

The contact email of the manager

hiringTs

int32 | null

The hiring timestamp of the employee in seconds

roleChangeTs

int32 | null

The last role timestamp of the employee in seconds

shift

string | null

Shift label (morning / evening / night / general)

lob

string | null

The lob of the employee

salutation

string | null

Salutation / title of address

Headers

Authorization

string

required

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

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK