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
date_of_birthDateTime (ISO 8601)remote_dataArraywork_locationUUIDmanagerUUIDwork_emailStringmobile_phone_numberStringavatarStringtermination_dateDateTime (ISO 8601)display_full_nameStringremote_idStringpreferred_nameStringpersonal_emailStringstart_dateDateTime (ISO 8601)marital_statusEnumlast_nameStringfirst_nameStringgenderEnumAccess 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
remote_idStringremote_dataArraydisplay_nameStringGET/organisations/{organisation_id}/employees/{employee_id}/employment_histories
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
employment_typeEnumremote_dataArrayjob_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_dataArrayend_dateDateTime (ISO 8601)net_payNumberremote_idStringstart_dateDateTime (ISO 8601)GET/organisations/{organisation_id}/teams
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_idStringremote_dataArraynameString