Common ModelsEmployees

/employees/{id}

Returns an Employee object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
employee_numberstring or null

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

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

Array of Employment IDs for this Employee.

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

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 null

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 null

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

The employment status of the employee.

  • ACTIVE - ACTIVE
  • PENDING - PENDING
  • INACTIVE - INACTIVE
Allowed values:
termination_datedatetime or null
The employee's termination date.
avatarstring or nullformat: "uri"<=2000 characters
The URL of the employee's avatar image.
custom_fieldsmap from strings to any or null
Custom fields configured for a given model.
remote_was_deletedbooleanRead-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 nullRead-only
remote_datalist of objects or nullRead-only
teamstring or nullformat: "uuid"Deprecated
The employee's team.
hire_datedatetime or nullDeprecated

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.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information