Employee data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
first_namestring
last_namestring
emails array
titlestring
manager_idstring
employment_status enum
Valid values:
"ACTIVE"
"INACTIVE"
gender enum
Valid values:
"MALE"
"FEMALE"
"INTERSEX"
"TRANS"
"NON_BINARY"
telephones array
date_of_birthdate
YYYYMM/DD
employee_numberstring
the company's ID for this employee
hired_atdate
The employee's start date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
terminated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
termination_reasonstring
marital_status enum
Valid values:
"MARRIED"
"SINGLE"
employment_type enum
Valid values:
"FULL_TIME"
"PART_TIME"
"CONTRACTOR"
"INTERN"
"CONSULTANT"
addressobject
language_localestring
currencystring
timezonestring
image_urlstring
This link expires after 1 hour.
company_idstring
(reference to HrisCompany)
pronounsstring
employee_roles enum array
Valid values:
"ADMIN"
"MANAGER"
"RECRUITER"
"SALESREP"
"INTERVIEWER"
compensation array
salutationstring
Mr. Mrs. Ms.
biostring
ssn_sinstring
groups array
Which groups/teams/units that this employee/user belongs to. May not have all of the Group fields present, but should have id, name, or email.
locations array
metadata array
storage_quota_allocatednumber
storage_quota_usednumber
storage_quota_availablenumber
relationships array
the employee's personal relationships (eg. emergency contacts, spouse, dependants, ...)
has_mfaboolean
does the user/employee have multi-factor authentication enabled
timeoff_days_totalnumber
Total time off allowance for the current leave period, in days (when reported by the provider)
timeoff_days_usednumber
Time off days used or booked in the current leave period (when reported by the provider)
Are we missing anything? Let us know
Was this page helpful?