v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB

hris

employee

Create an employee

post/hris/{connection_id}/employee

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring

created_atstring date-time

updated_atstring date-time

namestring

first_namestring

last_namestring

titlestring

manager_idstring

employment_status'ACTIVE' | 'INACTIVE'

gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'

date_of_birthstring date-time

employee_numberstring

hired_atstring date-time

terminated_atstring date-time

termination_reasonstring

marital_status'MARRIED' | 'SINGLE'

language_localestring

currencystring

timezonestring

image_urlstring

company_idstring

pronounsstring

employee_rolesstring[]

salutationstring

biostring

ssn_sinstring

storage_quota_allocatednumber

storage_quota_usednumber

storage_quota_availablenumber

has_mfaboolean

timeoff_days_totalnumber

timeoff_days_usednumber

rawobject

Response

Successful