The Employee object
The Employee object is used to represent any person who has been employed by a company. By default, it returns all employees. To filter for only active employees, set the employment_status query parameter to ACTIVE.
id
remote_id
The third-party API ID of the matching object.
created_at
The datetime that this object was created by Merge.
modified_at
The datetime that this object was modified by Merge.
employee_number
The employee's number that appears in the third-party integration's UI.
company
The ID of the employee's company.
first_name
The employee's first name.
last_name
The employee's last name.
preferred_name
The employee's preferred first name.
display_full_name
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.
username
The employee's username that appears in the remote UI.
groups
work_email
The employee's work email.
personal_email
The employee's personal email.
mobile_phone_number
The employee's mobile phone number.
employments
Array of `Employment` IDs for this Employee.
home_location
The employee's home address.
work_location
The employee's work address.
manager
The employee ID of the employee's manager.
pay_group
The employee's pay group
ssn
The employee's social security number.
gender
The employee's gender.
* `MALE` - MALE
* `FEMALE` - FEMALE
* `NON-BINARY` - NON-BINARY
* `OTHER` - OTHER
* `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
Allowed values:
ethnicity
The employee's ethnicity.
* `AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE
* `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT
* `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN
* `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO
* `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
* `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES
* `WHITE` - WHITE
* `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE
marital_status
The employee's filing status as related to marital status.
* `SINGLE` - SINGLE
* `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY
* `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY
* `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD
* `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD
Allowed values:
date_of_birth
The employee's date of birth.
start_date
The date that the employee started working. If an employee was rehired, the most recent start date will be returned.
remote_created_at
When the third party's employee was created.
employment_status
The employment status of the employee.
* `ACTIVE` - ACTIVE
* `PENDING` - PENDING
* `INACTIVE` - INACTIVE
Allowed values:
termination_date
The employee's termination date.
avatar
The URL of the employee's avatar image.
custom_fields
Custom fields configured for a given model.
remote_was_deleted
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
field_mappings
remote_data
teamDeprecated
The employee's team.
hire_dateDeprecated
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.