Common ModelsEmployees

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.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"
The ID of the employee's company.
first_namestring or nullOptional
The employee's first name.
last_namestring or nullOptional
The employee's last name.
preferred_namestring or nullOptional
The employee's preferred first name.
display_full_namestring or nullOptional
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.
usernamestring or nullOptional
The employee's username that appears in the remote UI.
groupslist of stringsOptional
work_emailstring or nullOptionalformat: "email"<=254 characters
The employee's work email.
personal_emailstring or nullOptionalformat: "email"<=254 characters
The employee's personal email.
mobile_phone_numberstring or nullOptional
The employee's mobile phone number.
employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"
The employee's home address.
work_locationstring or nullOptionalformat: "uuid"
The employee's work address.
managerstring or nullOptionalformat: "uuid"
The employee ID of the employee's manager.
pay_groupstring or nullOptionalformat: "uuid"
The employee's pay group
ssnstring or nullOptional<=100 characters
The employee's social security number.
genderenum or nullOptional

The employee’s gender.

  • MALE - MALE
  • FEMALE - FEMALE
  • NON-BINARY - NON-BINARY
  • OTHER - OTHER
  • PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE
Allowed values:
ethnicityenum or nullOptional

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_statusenum or nullOptional

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_birthdatetime or nullOptional
The employee's date of birth.
start_datedatetime or nullOptional
The date that the employee started working. If an employee was rehired, the most recent start date will be returned.
remote_created_atdatetime or nullOptional
When the third party's employee was created.
employment_statusenum or nullOptional

The employment status of the employee.

  • ACTIVE - ACTIVE
  • PENDING - PENDING
  • INACTIVE - INACTIVE
Allowed values:
termination_datedatetime or nullOptional
The employee's termination date.
avatarstring or nullOptionalformat: "uri"<=2000 characters
The URL of the employee's avatar image.
custom_fieldsmap from strings to any or nullOptional
Custom fields configured for a given model.
remote_was_deletedbooleanOptionalRead-only

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.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
teamstring or nullOptionalformat: "uuid"Deprecated
The employee's team.
hire_datedatetime or nullOptionalDeprecated

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.