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
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
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
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.
Allowed values:
ethnicityenum or nullOptional
The employee's ethnicity.
marital_statusenum or nullOptional
The employee's filing status as related to marital status.
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.
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
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