Employees
The
Employee object is used to represent any person who has been employed by a company.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
modified_atDateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
employee_numberStringOptional
The employee's number that appears in the third-party integration's UI.
companyUUIDOptional
The ID of the employee's company.
first_nameStringOptional
The employee's first name.
last_nameStringOptional
The employee's last name.
preferred_nameStringOptional
The employee's preferred first name.
display_full_nameStringOptional
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.
usernameStringOptional
The employee's username that appears in the remote UI.
groupsArrayRequired
work_emailStringOptional
The employee's work email.
personal_emailStringOptional
The employee's personal email.
mobile_phone_numberStringOptional
The employee's mobile phone number.
employmentsEmployment[]Required
Array of
Employment IDs for this Employee.The Employment object
The Employment object is used to represent a job position at a company.
Please note: When there is a change in pay or title, integrations with historical data will create new Employment objects while integrations without historical data will update existing ones.
Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
modified_atDateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
employeeUUIDOptional
The employee holding this position.
job_titleStringOptional
The position's title.
pay_rateNumberOptional
The position's pay rate in dollars.
pay_periodEnumOptional
The time period this pay rate encompasses. Possible values include:
HOUR, DAY, WEEK, EVERY_TWO_WEEKS, SEMIMONTHLY, MONTH, QUARTER, EVERY_SIX_MONTHS, YEAR. In cases where there is no clear mapping, the original value passed through will be returned.pay_frequencyEnumOptional
The position's pay frequency. Possible values include:
WEEKLY, BIWEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY, THIRTEEN-MONTHLY, PRO_RATA, SEMIMONTHLY. In cases where there is no clear mapping, the original value passed through will be returned.pay_currencyEnumOptional
The position's currency code. Possible values include:
XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL. In cases where there is no clear mapping, the original value passed through will be returned.pay_groupUUIDOptional
The employment's pay group
flsa_statusEnumOptional
The position's FLSA status. Possible values include:
EXEMPT, SALARIED_NONEXEMPT, NONEXEMPT, OWNER. In cases where there is no clear mapping, the original value passed through will be returned.effective_dateDateTime (ISO 8601)Optional
The position's effective date.
employment_typeEnumOptional
The position's type of employment. Possible values include:
FULL_TIME, PART_TIME, INTERN, CONTRACTOR, FREELANCE. In cases where there is no clear mapping, the original value passed through will be returned.remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
home_locationUUIDOptional
The employee's home address.
work_locationUUIDOptional
The employee's work address.
managerUUIDOptional
The employee ID of the employee's manager.
teamUUIDOptional
The employee's team.
pay_groupUUIDOptional
The employee's pay group
ssnStringOptional
The employee's social security number.
genderEnumOptional
The employee's gender. Possible values include:
MALE, FEMALE, NON-BINARY, OTHER, PREFER_NOT_TO_DISCLOSE. In cases where there is no clear mapping, the original value passed through will be returned.ethnicityEnumOptional
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. In cases where there is no clear mapping, the original value passed through will be returned.marital_statusEnumOptional
The employee's filing status as related to marital status. Possible values include:
SINGLE, MARRIED_FILING_JOINTLY, MARRIED_FILING_SEPARATELY, HEAD_OF_HOUSEHOLD, QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD. In cases where there is no clear mapping, the original value passed through will be returned.date_of_birthDateTime (ISO 8601)Optional
The employee's date of birth.
hire_dateDateTime (ISO 8601)DeprecatedOptional
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_dateDateTime (ISO 8601)Optional
The date that the employee started working. If an employee was rehired, the most recent start date will be returned.
remote_created_atDateTime (ISO 8601)Optional
When the third party's employee was created.
employment_statusEnumOptional
The employment status of the employee. Possible values include:
ACTIVE, PENDING, INACTIVE. In cases where there is no clear mapping, the original value passed through will be returned.termination_dateDateTime (ISO 8601)Optional
The employee's termination date.
avatarStringOptional
The URL of the employee's avatar image.
custom_fieldsObjectOptional
Custom fields configured for a given model.
remote_was_deletedBooleanRequired
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/employees
https://api.merge.dev/api/hris/v1/employees
US
EU
Returns a list of Employee objects.
Query & Path Parameters
company_idStringOptional
If provided, will only return employees for this company.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
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.
employment_statusStringOptional
If provided, will only return employees with this employment status.
employment_typeStringOptional
If provided, will only return employees that have an employment of the specified employment_type.
expandStringOptional
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
Whether to include data that was marked as deleted by third party webhooks.
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.
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_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
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_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
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
started_afterDateTime (ISO 8601)Optional
If provided, will only return employees that started after this datetime.
started_beforeDateTime (ISO 8601)Optional
If provided, will only return employees that started before this datetime.
team_idStringOptional
If provided, will only return employees for this team.
terminated_afterDateTime (ISO 8601)Optional
If provided, will only return employees that were terminated after this datetime.
terminated_beforeDateTime (ISO 8601)Optional
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.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
7shifts
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)work_emailString
ADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
AlexisHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
AllianceHCM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringtermination_dateDateTime (ISO 8601)work_emailString
Altera Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringtermination_dateDateTime (ISO 8601)work_emailString
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Breathe
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Charlie
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
ChartHop
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
ClayHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
CyberArk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgroupsArraylast_nameStringmanagerUUIDmobile_phone_numberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtermination_dateDateTime (ISO 8601)usernameStringwork_emailString
Dayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Deel
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDpersonal_emailStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUID
Employment Hero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArraylast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Factorial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Freshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Google Workspace
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringteamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Gusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Hibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
HR Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
HR Partner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Humaans
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Humi
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringmanagerUUIDmobile_phone_numberStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Insperity Premier
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUID
IntelliHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
IRIS Cascade
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
JumpCloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdisplay_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringteamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUID
Justworks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Kallidus
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Keka
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpay_groupUUIDpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Kenjo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_idStringstart_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Lano
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringwork_emailString
Lucca
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Microsoft Entra ID
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgroupsArraylast_nameStringmanagerUUIDmobile_phone_numberStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)usernameStringwork_emailString
Namely
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Nmbrs
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailString
Officient
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailString
Okta
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringteamUUIDtermination_dateDateTime (ISO 8601)work_emailString
OneLogin
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdisplay_full_nameStringemployment_statusEnumfirst_nameStringgroupsArraylast_nameStringmanagerUUIDmobile_phone_numberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringteamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailString
Oracle Human Capital Management (HCM)
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUID
OysterHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailString
PayCaptain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumhome_locationUUIDlast_nameStringmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUID
Paychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Paycom
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Paycor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
PayFit
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringfirst_nameStringgenderEnumhome_locationUUIDlast_nameStringmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailString
Paylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
PeopleHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Personio
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArraylast_nameStringmanagerUUIDmarital_statusEnumpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
PingOne
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployment_statusEnumfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtermination_dateDateTime (ISO 8601)usernameStringwork_emailString
Proliant
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Remote
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
Sage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailString
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUID
Sesame
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringteamUUIDwork_emailString
Square Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idString
TriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnumpay_groupUUIDpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
TriNet HR Platform
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUID
UKG Pro Workforce Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringwork_emailStringwork_locationUUID
UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailString
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUID
Zoho People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)work_emailStringPOST
/employees
Betahttps://api.merge.dev/api/hris/v1/employees
US
EU
Creates an Employee object with the given values.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.employee_numberStringThe employee's number that appears in the third-party integration's UI.
companyUUIDThe ID of the employee's company. Must pass in a valid Merge ID, which can be obtained from the
id field in the Company object.first_nameStringThe employee's first name.
last_nameStringThe employee's last name.
preferred_nameStringThe employee's preferred first name.
display_full_nameStringThe 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.
usernameStringThe employee's username that appears in the remote UI.
groupsArraywork_emailStringThe employee's work email.
personal_emailStringThe employee's personal email.
mobile_phone_numberStringThe employee's mobile phone number.
employmentsArrayArray of
Employment IDs for this Employee.home_locationUUIDThe employee's home address. Must pass in a valid Merge ID, which can be obtained from the
id field in the Location object.work_locationUUIDThe employee's work address. Must pass in a valid Merge ID, which can be obtained from the
id field in the Location object.managerUUIDThe employee ID of the employee's manager. Must pass in a valid Merge ID, which can be obtained from the
id field in the Employee object.teamUUIDThe employee's team. Must pass in a valid Merge ID, which can be obtained from the
id field in the Team object.pay_groupUUIDThe employee's pay group Must pass in a valid Merge ID, which can be obtained from the
id field in the PayGroup object.ssnStringThe employee's social security number.
genderEnumThe employee's gender. Must pass in one of the following choices:
MALE, FEMALE, NON-BINARY, OTHER, PREFER_NOT_TO_DISCLOSE.ethnicityEnumThe 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_statusEnumThe employee's filing status as related to 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_birthDateTime (ISO 8601)The employee's date of birth.
hire_dateDateTime (ISO 8601)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_dateDateTime (ISO 8601)The date that the employee started working. If an employee was rehired, the most recent start date will be returned.
employment_statusEnumThe employment status of the employee. Must pass in one of the following choices:
ACTIVE, PENDING, INACTIVE.termination_dateDateTime (ISO 8601)The employee's termination date.
avatarStringThe URL of the employee's avatar image.
integration_paramsObjectlinked_account_paramsObjectField support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
avatarStringOptional
date_of_birthDateTime (ISO 8601)Optional
display_full_nameStringOptional
employee_numberStringOptional
employment_statusEnumOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumOptional
first_nameStringOptional
genderEnumOptional
home_locationUUIDOptional
last_nameStringOptional
managerUUIDOptional
marital_statusEnumOptional
mobile_phone_numberStringOptional
personal_emailStringOptional
remote_idStringOptional
ssnStringOptional
start_dateDateTime (ISO 8601)Optional
teamUUIDOptional
termination_dateDateTime (ISO 8601)Optional
work_emailStringRequired
work_locationUUIDOptional
Humaans
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
companyUUIDOptional
date_of_birthDateTime (ISO 8601)Optional
display_full_nameStringOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumOptional
first_nameStringRequired
genderEnumOptional
hire_dateDateTime (ISO 8601)Optional
last_nameStringRequired
mobile_phone_numberStringOptional
personal_emailStringOptional
remote_idStringOptional
start_dateDateTime (ISO 8601)Required
teamUUIDOptional
work_emailStringRequired
work_locationUUIDRequired
IntelliHR
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
date_of_birthDateTime (ISO 8601)Optional
display_full_nameStringOptional
employee_numberStringRequired
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringOptional
genderEnumOptional
home_locationUUIDOptional
last_nameStringRequired
mobile_phone_numberStringOptional
personal_emailStringOptional
remote_idStringOptional
usernameStringOptional
work_emailStringOptional
Personio
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
display_full_nameStringOptional
employment_statusEnumOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringRequired
genderEnumOptional
groupsArrayOptional
last_nameStringRequired
remote_idStringOptional
start_dateDateTime (ISO 8601)Optional
work_emailStringRequired
work_locationUUIDOptional
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
companyUUIDRequired
date_of_birthDateTime (ISO 8601)Required
display_full_nameStringOptional
employee_numberStringOptional
employment_statusEnumOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringRequired
genderEnumRequired
home_locationUUIDRequired
last_nameStringRequired
managerUUIDRequired
pay_groupUUIDRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
ssnStringRequired
start_dateDateTime (ISO 8601)Required
usernameStringOptional
work_emailStringOptional
work_locationUUIDOptional
Additional POST Parameters
ethnicityStringRequired
integration_paramsObjectRequired
Benefit_Seniority_DateStringRequired
Seniority_DateStringRequired
benefit_seniority_dateStringRequired
deduction_benefit_groupStringRequired
deductions_groupStringRequired
earnings_groupStringRequired
federal_filing_statusStringRequired
local_work_in_tax_resident_statusStringRequired
resident_state_filing_statusStringRequired
scheduled_hoursStringRequired
seniority_dateStringRequired
state_filing_statusStringRequired
work_state_filing_statusStringRequired
ADP Workforce Now
AlexisHR
ChartHop
Dayforce
Freshteam
Gusto
HR Cloud
Kallidus
Lano
Namely
Nmbrs
Paylocity
Sage HR
Square Payroll
TriNet
UKG Ready
To include the correct model fields when making POST requests, use the GET /employees/meta/post endpoint. Learn more in our /meta guide.
GET
/employees/{id}
https://api.merge.dev/api/hris/v1/employees/{id}
US
EU
Returns an Employee object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
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.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
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
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
7shifts
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)work_emailStringADP Workforce Now
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDAlexisHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDAllianceHCM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringtermination_dateDateTime (ISO 8601)work_emailStringAltera Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringtermination_dateDateTime (ISO 8601)work_emailStringBambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDBreathe
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDCharlie
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDChartHop
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDClayHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)CyberArk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgroupsArraylast_nameStringmanagerUUIDmobile_phone_numberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringDayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDDeel
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDpersonal_emailStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUIDEmployment Hero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArraylast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDFactorial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDFreshteam
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDGoogle Workspace
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdisplay_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringteamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDGusto
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDHibob
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDHR Cloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDHR Partner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDHumaans
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDHumi
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringmanagerUUIDmobile_phone_numberStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDInsperity Premier
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUIDIntelliHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDIRIS Cascade
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDJumpCloud
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdisplay_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringteamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUIDJustworks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDKallidus
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDKeka
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpay_groupUUIDpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDKenjo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_idStringstart_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDLano
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringwork_emailStringLucca
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDMicrosoft Entra ID
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgroupsArraylast_nameStringmanagerUUIDmobile_phone_numberStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)usernameStringwork_emailStringNamely
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDNmbrs
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringOfficient
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringOkta
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployee_numberStringemployment_statusEnumfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringteamUUIDtermination_dateDateTime (ISO 8601)work_emailStringOneLogin
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdisplay_full_nameStringemployment_statusEnumfirst_nameStringgroupsArraylast_nameStringmanagerUUIDmobile_phone_numberStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringteamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringOracle Human Capital Management (HCM)
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUIDOysterHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmobile_phone_numberStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringPayCaptain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumhome_locationUUIDlast_nameStringmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUIDPaychex
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDPaycom
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDPaycor
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDPayFit
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringfirst_nameStringgenderEnumhome_locationUUIDlast_nameStringmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringPaylocity
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDPeopleHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDPersonio
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArraylast_nameStringmanagerUUIDmarital_statusEnumpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDPingOne
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployment_statusEnumfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringProliant
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)termination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDRemote
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDSage HR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUIDSesame
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringteamUUIDwork_emailStringSquare Payroll
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringlast_nameStringpersonal_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringTriNet
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnumpay_groupUUIDpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDTriNet HR Platform
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDUKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringwork_locationUUIDUKG Pro Workforce Management
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringwork_emailStringwork_locationUUIDUKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmanagerUUIDmobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)work_emailStringWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringcompanyUUIDdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhire_dateDateTime (ISO 8601)home_locationUUIDlast_nameStringmanagerUUIDmarital_statusEnummobile_phone_numberStringpay_groupUUIDpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)teamUUIDtermination_dateDateTime (ISO 8601)usernameStringwork_emailStringwork_locationUUIDZoho People
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
avatarStringdate_of_birthDateTime (ISO 8601)display_full_nameStringemployee_numberStringemployment_statusEnumemploymentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumfirst_nameStringgenderEnumgroupsArrayhome_locationUUIDlast_nameStringmarital_statusEnummobile_phone_numberStringpersonal_emailStringpreferred_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringssnStringstart_dateDateTime (ISO 8601)work_emailStringPOST
/employees/ignore/{model_id}
https://api.merge.dev/api/hris/v1/employees/ignore/{model_id}
US
EU
Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
Query & Path Parameters
model_idUUIDRequired
Body Parameters
reasonEnumRequired
Must pass in one of the following choices:
GENERAL_CUSTOMER_REQUEST, GDPR, OTHER.messageStringRequired
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
avatarStringOptional
date_of_birthDateTime (ISO 8601)Optional
display_full_nameStringOptional
employee_numberStringOptional
employment_statusEnumOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumOptional
first_nameStringOptional
genderEnumOptional
home_locationUUIDOptional
last_nameStringOptional
managerUUIDOptional
marital_statusEnumOptional
mobile_phone_numberStringOptional
personal_emailStringOptional
remote_idStringOptional
ssnStringOptional
start_dateDateTime (ISO 8601)Optional
teamUUIDOptional
termination_dateDateTime (ISO 8601)Optional
work_emailStringRequired
work_locationUUIDOptional
Humaans
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
companyUUIDOptional
date_of_birthDateTime (ISO 8601)Optional
display_full_nameStringOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumOptional
first_nameStringRequired
genderEnumOptional
hire_dateDateTime (ISO 8601)Optional
last_nameStringRequired
mobile_phone_numberStringOptional
personal_emailStringOptional
remote_idStringOptional
start_dateDateTime (ISO 8601)Required
teamUUIDOptional
work_emailStringRequired
work_locationUUIDRequired
IntelliHR
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
date_of_birthDateTime (ISO 8601)Optional
display_full_nameStringOptional
employee_numberStringRequired
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringOptional
genderEnumOptional
home_locationUUIDOptional
last_nameStringRequired
mobile_phone_numberStringOptional
personal_emailStringOptional
remote_idStringOptional
usernameStringOptional
work_emailStringOptional
Personio
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
display_full_nameStringOptional
employment_statusEnumOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringRequired
genderEnumOptional
groupsArrayOptional
last_nameStringRequired
remote_idStringOptional
start_dateDateTime (ISO 8601)Optional
work_emailStringRequired
work_locationUUIDOptional
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
companyUUIDRequired
date_of_birthDateTime (ISO 8601)Required
display_full_nameStringOptional
employee_numberStringOptional
employment_statusEnumOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringRequired
genderEnumRequired
home_locationUUIDRequired
last_nameStringRequired
managerUUIDRequired
pay_groupUUIDRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
ssnStringRequired
start_dateDateTime (ISO 8601)Required
usernameStringOptional
work_emailStringOptional
work_locationUUIDOptional
Additional POST Parameters
ethnicityStringRequired
integration_paramsObjectRequired
Benefit_Seniority_DateStringRequired
Seniority_DateStringRequired
benefit_seniority_dateStringRequired
deduction_benefit_groupStringRequired
deductions_groupStringRequired
earnings_groupStringRequired
federal_filing_statusStringRequired
local_work_in_tax_resident_statusStringRequired
resident_state_filing_statusStringRequired
scheduled_hoursStringRequired
seniority_dateStringRequired
state_filing_statusStringRequired
work_state_filing_statusStringRequired
ADP Workforce Now
AlexisHR
ChartHop
Dayforce
Freshteam
Gusto
HR Cloud
Kallidus
Lano
Namely
Nmbrs
Paylocity
Sage HR
Square Payroll
TriNet
UKG Ready
GET
/employees/meta/post
https://api.merge.dev/api/hris/v1/employees/meta/post
US
EU
Returns metadata for Employee POSTs.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
avatarStringOptional
date_of_birthDateTime (ISO 8601)Optional
display_full_nameStringOptional
employee_numberStringOptional
employment_statusEnumOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumOptional
first_nameStringOptional
genderEnumOptional
home_locationUUIDOptional
last_nameStringOptional
managerUUIDOptional
marital_statusEnumOptional
mobile_phone_numberStringOptional
personal_emailStringOptional
remote_idStringOptional
ssnStringOptional
start_dateDateTime (ISO 8601)Optional
teamUUIDOptional
termination_dateDateTime (ISO 8601)Optional
work_emailStringRequired
work_locationUUIDOptional
Humaans
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
companyUUIDOptional
date_of_birthDateTime (ISO 8601)Optional
display_full_nameStringOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayethnicityEnumOptional
first_nameStringRequired
genderEnumOptional
hire_dateDateTime (ISO 8601)Optional
last_nameStringRequired
mobile_phone_numberStringOptional
personal_emailStringOptional
remote_idStringOptional
start_dateDateTime (ISO 8601)Required
teamUUIDOptional
work_emailStringRequired
work_locationUUIDRequired
IntelliHR
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
date_of_birthDateTime (ISO 8601)Optional
display_full_nameStringOptional
employee_numberStringRequired
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringOptional
genderEnumOptional
home_locationUUIDOptional
last_nameStringRequired
mobile_phone_numberStringOptional
personal_emailStringOptional
remote_idStringOptional
usernameStringOptional
work_emailStringOptional
Personio
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
display_full_nameStringOptional
employment_statusEnumOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringRequired
genderEnumOptional
groupsArrayOptional
last_nameStringRequired
remote_idStringOptional
start_dateDateTime (ISO 8601)Optional
work_emailStringRequired
work_locationUUIDOptional
UKG Pro
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
companyUUIDRequired
date_of_birthDateTime (ISO 8601)Required
display_full_nameStringOptional
employee_numberStringOptional
employment_statusEnumOptional
employmentsEmployment[]idstringremote_idstringcreated_atstringmodified_atstringemployeestringjob_titlestringpay_ratenumberpay_periodstringpay_frequencystringpay_currencystringpay_groupstringflsa_statusstringeffective_datestringemployment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayfirst_nameStringRequired
genderEnumRequired
home_locationUUIDRequired
last_nameStringRequired
managerUUIDRequired
pay_groupUUIDRequired
remote_created_atDateTime (ISO 8601)Optional
remote_idStringOptional
ssnStringRequired
start_dateDateTime (ISO 8601)Required
usernameStringOptional
work_emailStringOptional
work_locationUUIDOptional
Additional POST Parameters
ethnicityStringRequired
integration_paramsObjectRequired
Benefit_Seniority_DateStringRequired
Seniority_DateStringRequired
benefit_seniority_dateStringRequired
deduction_benefit_groupStringRequired
deductions_groupStringRequired
earnings_groupStringRequired
federal_filing_statusStringRequired
local_work_in_tax_resident_statusStringRequired
resident_state_filing_statusStringRequired
scheduled_hoursStringRequired
seniority_dateStringRequired
state_filing_statusStringRequired
work_state_filing_statusStringRequired
ADP Workforce Now
AlexisHR
ChartHop
Dayforce
Freshteam
Gusto
HR Cloud
Kallidus
Lano
Namely
Nmbrs
Paylocity
Sage HR
Square Payroll
TriNet
UKG Ready