Employees
TheEmployee object is used to represent an Employee for a company.The Employee object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
employee_numberStringOptional
The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers.
companyStringOptional
first_nameStringOptional
The employee's first name.
last_nameStringOptional
The employee's last name.
display_full_nameStringOptional
The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.
groupsArrayRequired
work_emailStringOptional
The employee's work email.
personal_emailStringOptional
The employee's personal email.
mobile_phone_numberStringOptional
The employee's mobile phone number.
employmentsArrayRequired
Array of
Employment IDs for this Employee.home_locationStringOptional
work_locationStringOptional
managerStringOptional
teamStringOptional
pay_groupStringOptional
ssnStringOptional
The employee's social security number.
genderEnumOptional
The employee's gender. Possible values include:
MALE, FEMALE, NON-BINARY, OTHER, PREFER_NOT_TO_DISCLOSE, or - in cases where there is no clear mapping - the original value passed through.ethnicityEnumOptional
The employee's ethnicity. Possible values include:
AMERICAN_INDIAN_OR_ALASKA_NATIVE, ASIAN_OR_INDIAN_SUBCONTINENT, BLACK_OR_AFRICAN_AMERICAN, HISPANIC_OR_LATINO, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, TWO_OR_MORE_RACES, WHITE, PREFER_NOT_TO_DISCLOSE, or - in cases where there is no clear mapping - the original value passed through.marital_statusEnumOptional
The employee's marital status. Possible values include:
SINGLE, MARRIED_FILING_JOINTLY, MARRIED_FILING_SEPARATELY, HEAD_OF_HOUSEHOLD, QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD, or - in cases where there is no clear mapping - the original value passed through.date_of_birthStringOptional
The employee's date of birth.
hire_dateStringDeprecatedOptional
The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field.
The hire_date field on the Employee object is deprecated
start_dateStringOptional
The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date.
employment_statusEnumOptional
The employment status of the employee. Possible values include:
ACTIVE, PENDING, INACTIVE, or - in cases where there is no clear mapping - the original value passed through.termination_dateStringOptional
The employee's termination date.
avatarStringOptional
The URL of the employee's avatar image.
custom_fieldsObjectOptional
Custom fields configured for a given model.
remote_was_deletedBooleanRequired
The Employee object
JSON
{"id": "0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id": "19202938","employee_number": "2","company": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","first_name": "Greg","last_name": "Hirsch","display_full_name": "Cousin Greg Hirsch","groups": ["21a54124-397f-494d-985e-3c5b330b8a68"],"work_email": "[email protected]","personal_email": "[email protected]","mobile_phone_number": "+1234567890","employments": ["17a54124-287f-494d-965e-3c5b330c9a68"],"home_location": "d2f972d0-2526-434b-9409-4c3b468e08f0","work_location": "9efbc633-3387-4306-aa55-e2c635e6bb4f","manager": "0048ea5b-911e-4dff-9364-92070dea62ff","team": "249c9faa-3045-4a31-953b-8f22d3613301","pay_group": "ad1264e2-39be-4787-b749-f1aade9e3405","ssn": "1234567890","gender": "MALE","ethnicity": "WHITE","marital_status": "SINGLE","date_of_birth": "1990-11-10T00:00:00Z","start_date": "2020-10-11T00:00:00Z","employment_status": "INACTIVE","termination_date": "2021-10-12T00:00:00Z","avatar": "http://alturl.com/h2h8m","custom_fields": {},"remote_was_deleted": true}
GET
/employees
Returns a list of Employee objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
company_idStringOptional
If provided, will only return employees for this company.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
display_full_nameStringOptional
If provided, will only return employees with this display name.
employment_statusStringOptional
If provided, will only return employees with this employment status.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
first_nameStringOptional
If provided, will only return employees with this first name.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_sensitive_fieldsBooleanOptional
Whether to include sensitive fields (such as social security numbers) in the response.
last_nameStringOptional
If provided, will only return employees with this last name.
manager_idStringOptional
If provided, will only return employees for this manager.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
page_sizeIntegerOptional
Number of results to return per page.
pay_group_idStringOptional
If provided, will only return employees for this pay group
personal_emailStringOptional
If provided, will only return Employees with this personal email
remote_fieldsStringOptional
Which fields should be returned in non-normalized form.
remote_idStringOptional
The API provider's ID for the given object.
team_idStringOptional
If provided, will only return employees for this team.
work_emailStringOptional
If provided, will only return Employees with this work email
work_location_idStringOptional
If provided, will only return employees for this location.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id": "19202938","employee_number": "2","company": "8d9fd929-436c-4fd4-a48b-0c61f68d6178","first_name": "Greg","last_name": "Hirsch","display_full_name": "Cousin Greg Hirsch","groups": ["21a54124-397f-494d-985e-3c5b330b8a68"],"work_email": "[email protected]","personal_email": "[email protected]","mobile_phone_number": "+1234567890","employments": ["17a54124-287f-494d-965e-3c5b330c9a68"],"home_location": "d2f972d0-2526-434b-9409-4c3b468e08f0","work_location": "9efbc633-3387-4306-aa55-e2c635e6bb4f","manager": "0048ea5b-911e-4dff-9364-92070dea62ff","team": "249c9faa-3045-4a31-953b-8f22d3613301","pay_group": "ad1264e2-39be-4787-b749-f1aade9e3405","ssn": "1234567890","gender": "MALE","ethnicity": "WHITE","marital_status": "SINGLE","date_of_birth": "1990-11-10T00:00:00Z","start_date": "2020-10-11T00:00:00Z","employment_status": "INACTIVE","termination_date": "2021-10-12T00:00:00Z","avatar": "http://alturl.com/h2h8m","custom_fields": {},"remote_was_deleted": true}]}
Field support by platform
ADP Workforce Now
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumgroupsArrayhire_dateStringhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpay_groupStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
AlexisHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgenderEnumgroupsArrayhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Altera Payroll
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringssnStringtermination_dateStringwork_emailString
BambooHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Breathe
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Ceridian Dayforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhire_dateStringhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
CharlieHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumfirst_nameStringgenderEnumgroupsArraylast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
ChartHop
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Deel
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
display_full_nameStringfirst_nameStringgroupsArraylast_nameStringpersonal_emailStringremote_idStringteamStringwork_emailString
Factorial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Freshteam
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpay_groupStringpersonal_emailStringremote_idStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Gusto
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumfirst_nameStringgenderEnumhire_dateStringhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Hibob
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
HR Partner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Humaans.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
IntelliHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgenderEnumgroupsArrayhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringstart_dateStringtermination_dateStringwork_emailStringwork_locationString
Justworks
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhire_dateStringhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Lano
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
display_full_nameStringemployment_statusEnumfirst_nameStringlast_nameStringremote_idStringwork_emailString
Lucca
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Namely
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Nmbrs
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailString
Paychex
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Paylocity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpay_groupStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
PeopleHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumfirst_nameStringgenderEnumlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Personio
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringdisplay_full_nameStringemployment_statusEnumfirst_nameStringgenderEnumgroupsArraylast_nameStringmanagerStringmarital_statusEnumpersonal_emailStringremote_idStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Proliant
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringemployment_statusEnumethnicityEnumfirst_nameStringgroupsArrayhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringssnStringtermination_dateStringwork_emailStringwork_locationString
Rippling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Sage HR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringstart_dateStringteamStringtermination_dateStringwork_emailString
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringfirst_nameStringgenderEnumgroupsArraylast_nameStringmanagerStringmobile_phone_numberStringpersonal_emailStringremote_idStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Sapling
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumhome_locationStringlast_nameStringmanagerStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
Sesame
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
avatarStringcompanyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumfirst_nameStringgenderEnumlast_nameStringmobile_phone_numberStringremote_idStringssnStringwork_emailString
Square Payroll
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
display_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringlast_nameStringpersonal_emailStringremote_idString
TriNet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployment_statusEnumethnicityEnumfirst_nameStringgenderEnumgroupsArrayhire_dateStringhome_locationStringlast_nameStringmanagerStringmarital_statusEnumpay_groupStringremote_idStringssnStringstart_dateStringteamStringtermination_dateStringwork_emailStringwork_locationString
UKG Pro
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringdate_of_birthStringdisplay_full_nameStringemployee_numberStringemployment_status