Employees

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

The Employee object

Properties


idString
Optional

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.

companyString
Optional
The ID of the employee's company.

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.

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
Optional
Array of Employment IDs for this Employee.

home_locationString
Optional
The employee's home address.

work_locationString
Optional
The employee's work address.

managerString
Optional
The employee ID of the employee's manager.

teamString
Optional
The employee's team.

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

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.

remote_dataRemoteData[]
Optional

custom_fieldsObject
Optional
Custom fields configured for a given model.

The Employee object

{
  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "remote_id": "19202938",
  "employee_number": "2",
  "company": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
  "first_name": "Jane",
  "last_name": "Doe",
  "display_full_name": "Jane Doe",
  "work_email": "jane@merge.dev",
  "personal_email": "jane@gmail.com",
  "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",
  "ssn": "1234567890",
  "gender": "FEMALE",
  "ethnicity": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
  "marital_status": "SINGLE",
  "date_of_birth": "1990-11-10T00:00:00Z",
  "hire_date": "2020-10-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",
  "remote_data": [
    {
      "path": "/people",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "custom_fields": {}
}

GET

/employees

Returns a list of Employee objects.


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.

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

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 sensetive fields (such as social security numbers) in the response.

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.

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_location_idString
Optional
If provided, will only return employees for this location.

Response

{
  "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": "Jane",
      "last_name": "Doe",
      "display_full_name": "Jane Doe",
      "work_email": "jane@merge.dev",
      "personal_email": "jane@gmail.com",
      "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",
      "ssn": "1234567890",
      "gender": "FEMALE",
      "ethnicity": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
      "marital_status": "SINGLE",
      "date_of_birth": "1990-11-10T00:00:00Z",
      "hire_date": "2020-10-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",
      "remote_data": [
        {
          "path": "/people",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "custom_fields": {}
    }
  ]
}
Field support by platform

Sapling

Sapling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

employee_numberString

ethnicityEnum

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

termination_dateString

mobile_phone_numberString

home_locationString

display_full_nameString

remote_idString

Gusto

Gusto

Supported Response Fields


avatarString

date_of_birthString

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

personal_emailString

hire_dateString

companyString

termination_dateString

home_locationString

display_full_nameString

remote_idString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

ethnicityEnum

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

ssnString

companyString

termination_dateString

display_full_nameString

remote_idString

home_locationString

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

employee_numberString

ethnicityEnum

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

employee_numberString

ethnicityEnum

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

remote_dataRemoteData[]

personal_emailString

ssnString

hire_dateString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

managerString

employment_statusEnum

termination_dateString

remote_dataRemoteData[]

teamString

date_of_birthString

mobile_phone_numberString

home_locationString

display_full_nameString

personal_emailString

last_nameString

genderEnum

work_emailString

first_nameString

start_dateString

remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

home_locationString

display_full_nameString

remote_idString

Square Payroll

Square Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employment_statusEnum

remote_dataRemoteData[]

display_full_nameString

personal_emailString

employee_numberString

last_nameString

first_nameString

remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

managerString

employment_statusEnum

remote_dataRemoteData[]

teamString

date_of_birthString

ssnString

mobile_phone_numberString

home_locationString

display_full_nameString

personal_emailString

last_nameString

remote_idString

first_nameString

start_dateString

genderEnum

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

remote_dataRemoteData[]

personal_emailString

hire_dateString

termination_dateString

mobile_phone_numberString

home_locationString

display_full_nameString

remote_idString

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employee_numberString

ethnicityEnum

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

ssnString

hire_dateString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

employee_numberString

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

hire_dateString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

managerString

termination_dateString

remote_dataRemoteData[]

teamString

date_of_birthString

mobile_phone_numberString

display_full_nameString

genderEnum

employee_numberString

last_nameString

work_locationString

work_emailString

first_nameString

start_dateString

remote_idString

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

ethnicityEnum

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Lano

Lano

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employment_statusEnum

remote_dataRemoteData[]

display_full_nameString

last_nameString

work_emailString

first_nameString

remote_idString

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

managerString

employment_statusEnum

termination_dateString

remote_dataRemoteData[]

teamString

date_of_birthString

display_full_nameString

personal_emailString

work_locationString

remote_idString

last_nameString

work_emailString

first_nameString

start_dateString

genderEnum

marital_statusEnum

Justworks

Justworks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

personal_emailString

hire_dateString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Nmbrs

Nmbrs

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

termination_dateString

remote_dataRemoteData[]

teamString

date_of_birthString

mobile_phone_numberString

home_locationString

display_full_nameString

genderEnum

last_nameString

employee_numberString

personal_emailString

first_nameString

work_emailString

ssnString

start_dateString

remote_idString

Namely

Namely

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

home_locationString

display_full_nameString

remote_idString

Ceridian Dayforce

Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

hire_dateString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Paylocity

Paylocity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

ethnicityEnum

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

mobile_phone_numberString

home_locationString

display_full_nameString

remote_idString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

remote_dataRemoteData[]

personal_emailString

termination_dateString

mobile_phone_numberString

home_locationString

display_full_nameString

remote_idString
POST

/employees

BETA

Creates an Employee object with the given values.


Query & Path Parameters


run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters


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.

companyString
Optional
The ID of the employee's company. Must pass in a valid Merge ID, which can be obtained from the id field in the Company table.

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.

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.

home_locationString
Optional
The employee's home address. Must pass in a valid Merge ID, which can be obtained from the id field in the Home_location table.

work_locationString
Optional
The employee's work address. Must pass in a valid Merge ID, which can be obtained from the id field in the Work_location table.

managerString
Optional
The employee ID of the employee's manager. Must pass in a valid Merge ID, which can be obtained from the id field in the Manager table.

teamString
Optional
The employee's team. Must pass in a valid Merge ID, which can be obtained from the id field in the Team table.

ssnString
Optional
The employee's social security number.

genderEnum
Optional
The employee's gender. Must pass in one of the following choices: MALE, FEMALE, NON-BINARY, OTHER, PREFER_NOT_TO_DISCLOSE.

ethnicityEnum
Optional
The employee's ethnicity. Must pass in one of the following choices: 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.

marital_statusEnum
Optional
The employee's marital status. Must pass in one of the following choices: SINGLE, MARRIED_FILING_JOINTLY, MARRIED_FILING_SEPARATELY, HEAD_OF_HOUSEHOLD, QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD.

date_of_birthString
Optional
The employee's date of birth.

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

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. Must pass in one of the following choices: ACTIVE, PENDING, INACTIVE.

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.

Response

{
  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "remote_id": "19202938",
  "employee_number": "2",
  "company": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
  "first_name": "Jane",
  "last_name": "Doe",
  "display_full_name": "Jane Doe",
  "work_email": "jane@merge.dev",
  "personal_email": "jane@gmail.com",
  "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",
  "ssn": "1234567890",
  "gender": "FEMALE",
  "ethnicity": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
  "marital_status": "SINGLE",
  "date_of_birth": "1990-11-10T00:00:00Z",
  "hire_date": "2020-10-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",
  "remote_data": [
    {
      "path": "/people",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "custom_fields": {}
}
Field support by platform

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


avatarString
Optional

date_of_birthString
Optional

work_locationString
Optional

ethnicityEnum
Optional

work_emailString
Required

first_nameString
Required

managerString
Optional

employment_statusEnum
Optional

teamString
Required

last_nameString
Required

genderEnum
Optional

marital_statusEnum
Optional

personal_emailString
Optional

hire_dateString
Required

companyString
Optional

mobile_phone_numberString
Optional

home_locationString
Optional

display_full_nameString
Optional

remote_idString
Optional

Personio

Personio

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


companyString
Optional

teamString
Optional

work_locationString
Optional

last_nameString
Required

hire_dateString
Optional

work_emailString
Required

first_nameString
Required

genderEnum
Optional
GET

/employees/{id}

Returns an Employee object with the given id.


Query & Path Parameters


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

idString
Required

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 sensetive fields (such as social security numbers) in the response.

Response

{
  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "remote_id": "19202938",
  "employee_number": "2",
  "company": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
  "first_name": "Jane",
  "last_name": "Doe",
  "display_full_name": "Jane Doe",
  "work_email": "jane@merge.dev",
  "personal_email": "jane@gmail.com",
  "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",
  "ssn": "1234567890",
  "gender": "FEMALE",
  "ethnicity": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
  "marital_status": "SINGLE",
  "date_of_birth": "1990-11-10T00:00:00Z",
  "hire_date": "2020-10-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",
  "remote_data": [
    {
      "path": "/people",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "custom_fields": {}
}
Field support by platform

Sapling

Sapling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

employee_numberString

ethnicityEnum

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

termination_dateString

mobile_phone_numberString

home_locationString

display_full_nameString

remote_idString

Gusto

Gusto

Supported Response Fields


avatarString

date_of_birthString

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

personal_emailString

hire_dateString

companyString

termination_dateString

home_locationString

display_full_nameString

remote_idString

TriNet

TriNet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

ethnicityEnum

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

ssnString

companyString

termination_dateString

display_full_nameString

remote_idString

home_locationString

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

employee_numberString

ethnicityEnum

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

UKG Ready

UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

employee_numberString

ethnicityEnum

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

remote_dataRemoteData[]

personal_emailString

ssnString

hire_dateString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

managerString

employment_statusEnum

termination_dateString

remote_dataRemoteData[]

teamString

date_of_birthString

mobile_phone_numberString

home_locationString

display_full_nameString

personal_emailString

last_nameString

genderEnum

work_emailString

first_nameString

start_dateString

remote_idString

Paychex

Paychex

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

home_locationString

display_full_nameString

remote_idString

Square Payroll

Square Payroll

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


employment_statusEnum

remote_dataRemoteData[]

display_full_nameString

personal_emailString

employee_numberString

last_nameString

first_nameString

remote_idString

HR Partner

HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

companyString

managerString

employment_statusEnum

remote_dataRemoteData[]

teamString

date_of_birthString

ssnString

mobile_phone_numberString

home_locationString

display_full_nameString

personal_emailString

last_nameString

remote_idString

first_nameString

start_dateString

genderEnum

Rippling

Rippling

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

work_locationString

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Hibob

Hibob

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

remote_dataRemoteData[]

personal_emailString

hire_dateString

termination_dateString

mobile_phone_numberString

home_locationString

display_full_nameString

remote_idString

Humaans.io

Humaans.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

UKG Pro

UKG Pro

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employee_numberString

ethnicityEnum

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

ssnString

hire_dateString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

Zenefits

Zenefits

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

employee_numberString

work_locationString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_dataRemoteData[]

personal_emailString

ssnString

companyString

termination_dateString

mobile_phone_numberString

display_full_nameString

remote_idString

home_locationString

ADP Workforce Now

ADP Workforce Now

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


avatarString

date_of_birthString

work_locationString

ethnicityEnum

employee_numberString

work_emailString

first_nameString

managerString

employment_statusEnum

teamString

last_nameString

start_dateString

genderEnum

marital_statusEnum

remote_