For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Token-based authentication with required prefix “Bearer”
Path parameters
idstringRequiredformat: "uuid"
Headers
X-Account-TokenstringRequired
Token identifying the end user.
Query parameters
expandlist of enumsOptional
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
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.
ethnicityenum or nullOptional
The employee's ethnicity.
marital_statusenum or nullOptional
The employee's filing status as related to marital status.
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.
termination_datedatetime or nullOptional
The employee's termination date.
avatarstring or nullOptionalformat: "uri"<=2000 characters
The URL of the employee's avatar image.
employee_urlstring or nullOptionalformat: "uri"<=2000 characters
The 3rd party URL of the employee.
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.
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
