Employees

The Employee object is used to represent an Employee for a company.

The Employee object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

employee_numberString
Optional
The employee's number that appears in the remote UI. Note: This is distinct from the remote_id field, which is a unique identifier for the employee set by the remote API, and is not exposed to the user. This value can also change in many API providers.

companyString
Optional

first_nameString
Optional
The employee's first name.

last_nameString
Optional
The employee's last name.

display_full_nameString
Optional
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.

groupsArray
Required

work_emailString
Optional
The employee's work email.

personal_emailString
Optional
The employee's personal email.

mobile_phone_numberString
Optional
The employee's mobile phone number.

employmentsArray
Required
Array of Employment IDs for this Employee.

home_locationString
Optional

work_locationString
Optional

managerString
Optional

teamString
Optional

pay_groupString
Optional

ssnString
Optional
The employee's social security number.

genderEnum
Optional
The employee's gender. Possible values include: MALE, FEMALE, NON-BINARY, OTHER, PREFER_NOT_TO_DISCLOSE, or - in cases where there is no clear mapping - the original value passed through.

ethnicityEnum
Optional
The employee's ethnicity. Possible values include: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ASIAN_OR_INDIAN_SUBCONTINENT, BLACK_OR_AFRICAN_AMERICAN, HISPANIC_OR_LATINO, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, TWO_OR_MORE_RACES, WHITE, PREFER_NOT_TO_DISCLOSE, or - in cases where there is no clear mapping - the original value passed through.

marital_statusEnum
Optional
The employee's marital status. Possible values include: SINGLE, MARRIED_FILING_JOINTLY, MARRIED_FILING_SEPARATELY, HEAD_OF_HOUSEHOLD, QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD, or - in cases where there is no clear mapping - the original value passed through.

date_of_birthString
Optional
The employee's date of birth.

hire_dateStringDeprecated
Optional
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.

The hire_date field on the Employee object is deprecated


start_dateString
Optional
The date that the employee started working. If an employee has multiple start dates from previous employments, this represents the most recent start date.

employment_statusEnum
Optional
The employment status of the employee. Possible values include: ACTIVE, PENDING, INACTIVE, or - in cases where there is no clear mapping - the original value passed through.

termination_dateString
Optional
The employee's termination date.

avatarString
Optional
The URL of the employee's avatar image.

custom_fieldsObject
Optional
Custom fields configured for a given model.

remote_was_deletedBoolean
Required

The Employee object
JSON
{
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "19202938",
"employee_number": "2",
"company": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
"first_name": "Greg",
"last_name": "Hirsch",
"display_full_name": "Cousin Greg Hirsch",
"groups": [
"21a54124-397f-494d-985e-3c5b330b8a68"
],
"work_email": "[email protected]",
"personal_email": "[email protected]",
"mobile_phone_number": "+1234567890",
"employments": [
"17a54124-287f-494d-965e-3c5b330c9a68"
],
"home_location": "d2f972d0-2526-434b-9409-4c3b468e08f0",
"work_location": "9efbc633-3387-4306-aa55-e2c635e6bb4f",
"manager": "0048ea5b-911e-4dff-9364-92070dea62ff",
"team": "249c9faa-3045-4a31-953b-8f22d3613301",
"pay_group": "ad1264e2-39be-4787-b749-f1aade9e3405",
"ssn": "1234567890",
"gender": "MALE",
"ethnicity": "WHITE",
"marital_status": "SINGLE",
"date_of_birth": "1990-11-10T00:00:00Z",
"start_date": "2020-10-11T00:00:00Z",
"employment_status": "INACTIVE",
"termination_date": "2021-10-12T00:00:00Z",
"avatar": "http://alturl.com/h2h8m",
"custom_fields": {},
"remote_was_deleted": true
}

GET

/employees

Returns a list of Employee objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


company_idString
Optional
If provided, will only return employees for this company.

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

display_full_nameString
Optional
If provided, will only return employees with this display name.

employment_statusString
Optional
If provided, will only return employees with this employment status.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

first_nameString
Optional
If provided, will only return employees with this first name.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

include_sensitive_fieldsBoolean
Optional
Whether to include sensitive fields (such as social security numbers) in the response.

last_nameString
Optional
If provided, will only return employees with this last name.

manager_idString
Optional
If provided, will only return employees for this manager.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

pay_group_idString
Optional
If provided, will only return employees for this pay group

personal_emailString
Optional
If provided, will only return Employees with this personal email

remote_fieldsString
Optional
Which fields should be returned in non-normalized form.

remote_idString
Optional
The API provider's ID for the given object.

team_idString
Optional
If provided, will only return employees for this team.

work_emailString
Optional
If provided, will only return Employees with this work email

work_location_idString
Optional
If provided, will only return employees for this location.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "19202938",
"employee_number": "2",
"company": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
"first_name": "Greg",
"last_name": "Hirsch",
"display_full_name": "Cousin Greg Hirsch",
"groups": [
"21a54124-397f-494d-985e-3c5b330b8a68"
],
"work_email": "[email protected]",
"personal_email": "[email protected]",
"mobile_phone_number": "+1234567890",
"employments": [
"17a54124-287f-494d-965e-3c5b330c9a68"
],
"home_location": "d2f972d0-2526-434b-9409-4c3b468e08f0",
"work_location": "9efbc633-3387-4306-aa55-e2c635e6bb4f",
"manager": "0048ea5b-911e-4dff-9364-92070dea62ff",
"team": "249c9faa-3045-4a31-953b-8f22d3613301",
"pay_group": "ad1264e2-39be-4787-b749-f1aade9e3405",
"ssn": "1234567890",
"gender": "MALE",
"ethnicity": "WHITE",
"marital_status": "SINGLE",
"date_of_birth": "1990-11-10T00:00:00Z",
"start_date": "2020-10-11T00:00:00Z",
"employment_status": "INACTIVE",
"termination_date": "2021-10-12T00:00:00Z",
"avatar": "http://alturl.com/h2h8m",
"custom_fields": {},
"remote_was_deleted": true
}
]
}
Field support by platform

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

groupsArray

hire_dateString

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

pay_groupString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

AlexisHR

AlexisHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

first_nameString

genderEnum

groupsArray

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Altera Payroll

Altera Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

groupsArray

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

termination_dateString

work_emailString

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Breathe

Breathe

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

hire_dateString

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

CharlieHR

CharlieHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employment_statusEnum

first_nameString

genderEnum

groupsArray

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

ChartHop

ChartHop

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Deel

Deel

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_full_nameString

first_nameString

groupsArray

last_nameString

personal_emailString

remote_idString

teamString

work_emailString

Factorial

Factorial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

display_full_nameString

employment_statusEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

mobile_phone_numberString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

display_full_nameString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

groupsArray

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

pay_groupString

personal_emailString

remote_idString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Gusto

Gusto

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employment_statusEnum

first_nameString

genderEnum

hire_dateString

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employment_statusEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

mobile_phone_numberString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employment_statusEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

IntelliHR

IntelliHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

first_nameString

genderEnum

groupsArray

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

start_dateString

termination_dateString

work_emailString

work_locationString

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

hire_dateString

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Lano

Lano

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_full_nameString

employment_statusEnum

first_nameString

last_nameString

remote_idString

work_emailString

Lucca

Lucca

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employee_numberString

first_nameString

genderEnum

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

groupsArray

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employee_numberString

first_nameString

genderEnum

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

pay_groupString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

PeopleHR

PeopleHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employment_statusEnum

first_nameString

genderEnum

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

display_full_nameString

employment_statusEnum

first_nameString

genderEnum

groupsArray

last_nameString

managerString

marital_statusEnum

personal_emailString

remote_idString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Proliant

Proliant

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employment_statusEnum

ethnicityEnum

first_nameString

groupsArray

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

termination_dateString

work_emailString

work_locationString

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

start_dateString

teamString

termination_dateString

work_emailString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employee_numberString

first_nameString

genderEnum

groupsArray

last_nameString

managerString

mobile_phone_numberString

personal_emailString

remote_idString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Sapling

Sapling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

display_full_nameString

employee_numberString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

home_locationString

last_nameString

managerString

marital_statusEnum

mobile_phone_numberString

personal_emailString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

Sesame

Sesame

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

date_of_birthString

display_full_nameString

employment_statusEnum

first_nameString

genderEnum

last_nameString

mobile_phone_numberString

remote_idString

ssnString

work_emailString

Square Payroll

Square Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


display_full_nameString

employee_numberString

employment_statusEnum

first_nameString

last_nameString

personal_emailString

remote_idString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employment_statusEnum

ethnicityEnum

first_nameString

genderEnum

groupsArray

hire_dateString

home_locationString

last_nameString

managerString

marital_statusEnum

pay_groupString

remote_idString

ssnString

start_dateString

teamString

termination_dateString

work_emailString

work_locationString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

date_of_birthString

display_full_nameString

employee_numberString

employment_status