Common ModelsEmployees

/employees

Returns a list of Employee objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

company_idstringOptional
If provided, will only return employees for this company.
created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
display_full_namestringOptional
If provided, will only return employees with this display name.
employee_numberstringOptional
If provided, will only return employees with this employee number.
employment_statusenumOptional
If provided, will only return employees with this employment status. * `ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE
Allowed values:
employment_typestringOptional
If provided, will only return employees that have an employment of the specified employment type.
expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
first_namestringOptional
If provided, will only return employees with this first name.
groupsstringOptional

If provided, will only return employees matching the group ids; multiple groups can be separated by commas.

home_location_idstringOptional
If provided, will only return employees for this home location.
include_deleted_databooleanOptional

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.

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).

job_titlestringOptional
If provided, will only return employees that have an employment of the specified job title.
last_namestringOptional
If provided, will only return employees with this last name.
manager_idstringOptional
If provided, will only return employees for this manager.
modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
pay_group_idstringOptional
If provided, will only return employees for this pay group
personal_emailstringOptional
If provided, will only return Employees with this personal email
remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

remote_idstringOptional
The API provider's ID for the given object.
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)
started_afterdatetimeOptional
If provided, will only return employees that started after this datetime.
started_beforedatetimeOptional
If provided, will only return employees that started before this datetime.
team_idstringOptional
If provided, will only return employees for this team.
terminated_afterdatetimeOptional
If provided, will only return employees that were terminated after this datetime.
terminated_beforedatetimeOptional
If provided, will only return employees that were terminated before this datetime.
work_emailstringOptional
If provided, will only return Employees with this work email
work_location_idstringOptional
If provided, will only return employees for this location.

Response

nextstring or null
previousstring or null
resultslist of objects

Field support by integration

See all supported fields

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