HR Partner
Common Model Sync Frequencies
Accessed third-party endpoints
Merge interacts with HR Partner API endpoints to access certain information as detailed below.
API Endpoints

GET/dependents
Merge interacts with this API endpoint to...
Access Dependent information
Dependent fields
date_of_birthDateTime (ISO 8601)

first_nameString

phone_numberString

remote_dataArray

employeeUUID

relationshipEnum

remote_idString
GET/company
Merge interacts with this API endpoint to...
Access Company information
Company fields
display_nameString

legal_nameString

remote_dataArray
Access Employee information
Employee fields
companyUUID
GET/employees
Merge interacts with this API endpoint to...
Access Team information
Team fields
remote_dataArray

nameString
Access Location information
Location fields
remote_dataArray

nameString
Access Group information
Group fields
nameString
Access Employee information
Employee fields
termination_dateDateTime (ISO 8601)

teamUUID

date_of_birthDateTime (ISO 8601)

first_nameString

start_dateDateTime (ISO 8601)

work_emailString

work_locationUUID

remote_dataArray

employment_statusEnum

genderEnum

last_nameString

display_full_nameString

remote_idString
GET/employee/{employee_code}
Merge interacts with this API endpoint to...
Access Location information
Location fields
street_1String

zip_codeString

street_2String

remote_dataArray

countryEnum

stateString

cityString

remote_idString
Access Employee information
Employee fields
genderEnum

date_of_birthDateTime (ISO 8601)

termination_dateDateTime (ISO 8601)

first_nameString

start_dateDateTime (ISO 8601)

managerUUID

remote_dataArray

employment_statusEnum

home_locationUUID

last_nameString

display_full_nameString

ssnString

remote_idString
Access Employment information
Employment fields
employeeUUID
Access Benefit information
Benefit fields
employeeUUID

start_dateDateTime (ISO 8601)
Access TimeOff information
TimeOff fields
employeeUUID
GET/positions
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
effective_dateDateTime (ISO 8601)

employment_typeEnum

pay_periodEnum

pay_rateNumber

remote_dataArray

job_titleString

remote_idString
GET/benefits
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
company_contributionNumber

end_dateDateTime (ISO 8601)

remote_dataArray

provider_nameString

remote_idString

benefit_plan_typeString
GET/absences
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
start_timeDateTime (ISO 8601)

end_timeDateTime (ISO 8601)

statusEnum

employee_noteString

unitsEnum

remote_dataArray

request_typeEnum

amountNumber

remote_idString