Skip to main content
POST
Create Employee

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Body

application/json
title
string | null

The prefix of the employee's name (e.g., Mr, Ms, Dr)

Example:

"Mr"

first_name
string | null

The employee first name

Example:

"Isaac"

last_name
string | null

The employee last name

Example:

"Newton"

name
string | null

The employee name

Example:

"Isaac Newton"

display_name
string | null

The employee display name

Example:

"Sir Isaac Newton"

avatar_url
string | null

The employee avatar Url

Example:

"https://example.com/avatar.png"

personal_email
string | null

The employee personal email

Example:

"isaac.newton@example.com"

personal_phone_number
string | null

The employee personal phone number

Example:

"+1234567890"

work_email
string | null

The employee work email

Example:

"newton@example.com"

work_phone_number
string | null

The employee work phone number

Example:

"+1234567890"

job_id
string | null
deprecated

The employee job id

Example:

"R-6789"

job_title
string | null

If the source of the job_title is the Employee's current Employment, and that Employment pertains exclusively to this Employee, then the active Employment job_title will also be written

Example:

"Physicist"

department_id
string | null

The employee department id

Example:

"3093"

team_id
string | null

The employee team id

Example:

"2913"

department
string | null

The employee department

Example:

"Physics"

manager_id
string | null

The employee manager ID

Example:

"67890"

gender
object | null

The employee gender

Example:

"male"

preferred_language
object | null

The employee preferred language

Example:

"eng"

ethnicity
object | null

The employee ethnicity

Example:

"white"

date_of_birth
string<date-time> | null

The date when the employee was born

Example:

"1990-01-01T00:00:00.000Z"

birthday
string<date-time> | null

The next birthday of the employee (upcoming birthday)

Example:

"2021-01-01T00:00:00Z"

marital_status
object | null

The employee marital status

Example:

"single"

avatar
object | null

The employee avatar

Example:

"https://example.com/avatar.png"

hire_date
string<date-time> | null

The employee hire date

Example:

"2021-01-01T00:00:00.000Z"

start_date
string<date-time> | null

The employee start date

Example:

"2021-01-01T00:00:00.000Z"

employment_type
object | null
deprecated

The employee employment type

Example:

"permanent"

employment_contract_type
object | null
deprecated

The employment work schedule type (e.g., full-time, part-time)

Example:

"full_time"

employment_status
object | null

The employee employment status

Example:

"active"

termination_date
string<date-time> | null

The employee termination date

Example:

"2021-01-01T00:00:00Z"

company_name
string | null
deprecated

The employee company name

Example:

"Example Corp"

company_id
string | null

The employee company id

Example:

"1234567890"

citizenships
object[] | null

The citizenships of the Employee

employments
object[] | null
deprecated

The employee employments

employment
object | null

The employee employment

custom_fields
object[] | null

The employee custom fields

benefits
object[] | null

Current benefits of the employee

employee_number
string | null

The assigned employee number

Example:

"125"

national_identity_number
object | null
deprecated

The national identity number

national_identity_numbers
object[] | null

The national identity numbers

home_location
object | null

The employee home location

work_location
object | null

The employee work location

cost_centers
object[] | null

The employee cost centers

passthrough
object | null

Value to pass through to the provider

Example:

Response

The employee was created successfully.

statusCode
number
required
Example:

201

message
string
required
Example:

"Record created successfully."

timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"

data
object
required