Employment Hero
Beta
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
countryEnumnameStringAccess Employee information
Employee fields
genderEnumwork_emailStringfirst_nameStringremote_dataArraymarital_statusEnumavatarStringpreferred_nameStringtermination_dateDateTime (ISO 8601)start_dateDateTime (ISO 8601)work_locationUUIDpersonal_emailStringmobile_phone_numberStringlast_nameStringdisplay_full_nameStringmanagerUUIDdate_of_birthDateTime (ISO 8601)remote_idStringAccess Employment information
Employment fields
employeeUUIDAccess EmployeePayrollRun information
EmployeePayrollRun fields
employeeUUIDGET/organisations
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
companyUUIDAccess Company information
Company fields
display_nameStringremote_dataArrayremote_idStringGET/organisations/{organisation_id}/employees/{employee_id}/employment_histories
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
remote_dataArrayemployment_typeEnumjob_titleStringeffective_dateDateTime (ISO 8601)remote_idStringGET/organisations/{organisation_id}/employees/{employee_id}/payslips
Merge interacts with this API endpoint to...
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_dataArraystart_dateDateTime (ISO 8601)end_dateDateTime (ISO 8601)net_payNumberremote_idStringGET/organisations/{organisation_id}/teams
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_dataArrayremote_idStringnameString