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

GET/organisations/{organisation_id}/employees
Merge interacts with this API endpoint to...
Access Location information
Location fields
countryEnum

nameString
Access Employee information
Employee fields
date_of_birthDateTime (ISO 8601)

remote_dataArray

work_locationUUID

managerUUID

work_emailString

mobile_phone_numberString

avatarString

termination_dateDateTime (ISO 8601)

display_full_nameString

remote_idString

preferred_nameString

personal_emailString

start_dateDateTime (ISO 8601)

marital_statusEnum

last_nameString

first_nameString

genderEnum
Access Employment information
Employment fields
employeeUUID
Access EmployeePayrollRun information
EmployeePayrollRun fields
employeeUUID
GET/organisations
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
companyUUID
Access Company information
Company fields
remote_idString

remote_dataArray

display_nameString
GET/organisations/{organisation_id}/employees/{employee_id}/employment_histories
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
employment_typeEnum

remote_dataArray

job_titleString

effective_dateDateTime (ISO 8601)

remote_idString
GET/organisations/{organisation_id}/employees/{employee_id}/payslips
Merge interacts with this API endpoint to...
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_dataArray

end_dateDateTime (ISO 8601)

net_payNumber

remote_idString

start_dateDateTime (ISO 8601)
GET/organisations/{organisation_id}/teams
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_idString

remote_dataArray

nameString