Skip to main content

Sync HRIS Data From Employment Hero via the API

Learn how to sync employee data from Employment Hero into Culture Amp using a secure, one-way API integration.

Jessie Walsh avatar
Written by Jessie Walsh
Updated today

Who can use this feature?

Available on:

  • All Culture Amp subscriptions.

You can import employee data directly from Employment Hero into Culture Amp using a secure, one-way API connection. This ensures your employee list and demographics are always up-to-date.

Data Flow: Employee Data flows from Employment Hero into Culture Amp (one-way sync). Changes made in Culture Amp will not sync back to your HRIS.

Initial Setup Timeframe: Due to specific API requirements regarding unique identifiers and custom group mapping, the setup process typically takes 1–3 weeks. To prevent duplicate profiles, the administrator connecting the integration must have full system permissions. We recommend involving an administrator familiar with your Employment Hero configuration to assist with testing.

Choosing Your Integration Method


We offer two primary ways to connect your employee data. The table below briefly outlines both, and should help with the decision on which is the best approach for your organization:

Method

Type of Import

Best For

Key Difference

Full Integration (API)

Full Employee Import

Organizations seeking real-time, daily automation of all employee data that the API supports.

Data transfer is handled automatically via a secure API connection. Users with an End Date in the HRIS become former employees instantly upon sync. If a user is simply removed from the sync report without an End Date, they will remain "Active" in Culture Amp until a manual sync is performed by our Culture Amp Support team. Properly terminating employees in your HRIS with an End Date is the only way to guarantee automatic deactivation.

Partial Employee Import

Organizations that need complete control over file creation or have unique filtering requirements.

You generate a file and securely transfer it to us at scheduled intervals. Users missing from the file are ignored unless you include an end date.

API Integration Checklist


  1. Access Requirements — Prerequisites and system logic.

  2. Step 1: Connect & Authenticate — Locating and entering your API credentials.

  3. Step 2: Field Mapping — Aligning your Employment Hero demographics with Culture Amp.

  4. Step 3: Activate Integration — Establishing the technical connection.

  5. Step 4: Run Your First Sync — Reviewing and importing employee records.

  6. Troubleshooting & FAQs — Solving errors, duplicates, and sync blocks.

Before You Start: Access Requirements & Terminology


To set up the connection, you’ll need:

Important Considerations & Data Limitations

  • Employee Exclusion Limitation: Employment Hero does not support an exclusion field via the API. If you need to exclude users, please refer to the Excluding Employees (Workaround)

  • Employee ID Mapping: The default mapping for Employee ID often results in a blank field in Culture Amp. We recommend chatting with a Culture Amp Support Specialist to confirm the back-end mapping has been configured to pull the data from the Employee Code field in Employment Hero.

  • Field Limitations: The Employment Hero integration has limited access to custom fields. If a required demographic isn’t available to map, you may need to manage that data directly in Culture Amp through a manual user import. Reply with "Ask a person" in a support conversation to be connected with a Support Specialist to see what options are available.

  • Initial Setup Timeframe: Due to field limitations and system complexity, the integration setup could take anywhere between 1-3 weeks. We recommend involving a technical Employment Hero administrator or somebody familiar with the Employment Hero configuration, and allocating sufficient time and resources for best results.

Required Permissions & Rationale

Having the correct Employment Hero permissions is essential for a successful connection.

Tip: For the full list of fields and objects accessed by the connector, please refer to the Employment Hero API Reference Guide.

Permission/Role

Needed in Employment Hero

Rationale (Data it unlocks in Culture Amp)

Administrator Access

Employment Hero Administrator role

Required to authorize the API connection and allow read access to all employee data.

Employee Data

GET /employees

This provides the core identity demographics: Name, Work Email, Date of Birth, and Employee Code.

Employment Details

GET /employment_histories

This provides the timeline demographics: Start Date and Termination Date.

Teams & Groups

GET /teams

This provides Organizational Demographics such as Department, Team, or Business Unit.

Step 1: Connect and Authenticate Your Employment Hero Account


  1. Sign in to Culture Amp with an account that has Account Administrator or Employee data administrator access.

  2. Navigate to your Settings > Account > Integrations page.

  3. Select Employment Hero from the list of integrations and click Continue setup.

  4. You will be shown a screen indicating that an Employment Hero Administrator role is required. Click I am an admin.

  5. Click Next to authorize Culture Amp's request to read your Employment Hero employee data.

  6. You will be prompted to log in to connect your Employment Hero account. Click Open window and enter your Employment Hero email address and password to finalize the connection.

Step 2: Setting Up Demographic Field Mapping


Once you have authenticated with Employment Hero, you will be prompted to map the demographic fields you would like to import into Culture Amp.

Note: Core demographic fields map automatically and should not be manually configured unless instructed by a Culture Amp specialist. Please note that once these fields are set up, they cannot be edited or deleted. If you need to make changes, reply with "ask a person" in a support conversation to speak with a specialist.

Core Demographics: Automatic Mapping

This table is intended for your technical Employment Hero administrator. The following fields will sync automatically from Employment Hero to Culture Amp.

Note: While the "Typical Employment Hero UI Label" shows the common reference field in Employment Hero, exact UI labels and underlying field names may vary by tenant and configuration.

Typical Employment Hero UI Label

Employment Hero Endpoint (Data Location)

Culture Amp Field

Work Email

GET /employees

Email (Unique Identifier)

Employee Code

GET /employees

Employee ID (Unique Identifier)

First Name / Last Name

GET /employees

Name

Preferred Name

GET /employees

Preferred Name

Date of Birth

GET /employees

Date of Birth

Start Date

GET /employment_histories

Start Date

Termination Date

GET /employment_histories

End Date

Reports To (Work Email of referenced Manager)

GET /employees

Manager Email (Hierarchy)

Tip: The default connection for Employee ID often results in a blank ID. If IDs are missing after you run a sync, please reply with "Ask a Person" in a support conversation to speak with a Product Support Specialist to arrange a custom mapping.

Custom Demographics: Manual Mapping

If you track additional employee data in Employment Hero that you want to use as demographics in Culture Amp, follow these steps to set up custom mapping.

mapping.

Step 1. Map Fields

  • Click Map Fields.

Step 2. Select the Data Model for Target Field

  • From the target field dropdown, select Employee.

Step 3. Set Details for the Target Field

  • Specify the details for the field you want to target (e.g., Gender).

Step 4. Choose the Matching Field from Employment Hero

  • Select the matching field from Employment Hero and click Save.

Step 5. Save Mappings

  • You can either Save mappings or click the + Field Mapping button to add more.

Tip: If you cannot find a required demographic field during mapping, it may be due to API limitations. You may need to:

  • Map an alternate custom field that contains similar data.

  • Manage the demographic directly in Culture Amp via manual imports.

Excluding Employees (Optional)

Employment Hero does not support an exclusion field via the API. If you need to exclude users from your sync, you must use Culture Amp’s bulk deactivation feature as a workaround.

  1. Allow the initial sync to import all users from Employment Hero, including those you want to exclude.

  2. In Culture Amp, export a copy of your user list:

    • Go to Settings > Employee Data > Users > Import & Export > Export

    • Check the box for Include deactivated users

    • The export will contain a column labeled Employee Deactivated.

  3. Update the Employee Deactivated column in the exported file:

    • Assign "TRUE" to all users you want to exclude (they will be deactivated).

    • Assign "FALSE" to users who should remain active.

  4. Save the file and perform a manual partial import:

    • Go to Settings > Employee Data > Users > Import & Export > Import users > Upload your file > Partial import.

  5. Once complete, deactivated users will remain deactivated and will not be reactivated in future syncs.

Step 3: Activate Integration


After mapping your fields, click Sync and the system will run an initial sync to connect your Employment Hero account details and mappings.

Note: This sync does not import employee data yet.

  • You will see a "Syncing data" message. This initial sync can take up to 12 hours to complete, depending on the size and complexity of your Employment Hero configuration.

  • Feel free to navigate away from the page. The process runs in the background.

  • The "Syncing data" message confirms the connection and mapping setup. Once this first sync completes, you can proceed to import your employee data through another sync.

Note: As part of our commitment to data security, only data relevant to your import and field mappings will be stored.

Step 4: Run Your First Employee Data Sync


Once the initial setup sync is complete, the Integrations page in Culture Amp will update. Follow these steps to run your first employee data import:

  1. Click the Finalise sync button.

  2. Click Get Started.

  3. On the review page, ensure Sync is selected in the "Sync with merge" section (ignore the other options).

  4. Culture Amp will validate the data. If there are no concerns, click Next.

  5. Review the data: Carefully examine the review screen, which shows the number of new employees to be created, existing employees to be updated, and employees to be deactivated. If there are any issues, check the troubleshooting section below or ask our Culture Amp Product Support team for help.

  6. Hit Import Data to pull the employees into Culture Amp.

  7. After the import is complete, click Go to Users to review the new users.

Important: If you see any unexpected numbers (e.g., too many employees being deactivated or created), do not proceed with the import. Check the Troubleshooting section or reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.

Once these steps are completed, you will see the green "Syncing data" notification appear on the Integrations page.

After syncing is complete, you will see the latest sync information, including the date and time of the last sync, and confirmation that your integration is Connected on the Integrations page.

Set Up Automated Daily Syncs

By default, auto-syncs are off. We recommend enabling daily syncing to ensure your employee demographics are kept up-to-date.

  1. To enable: Go to Integrations, click on the Off button and toggle Auto-sync On.

  2. To disable: Go to Integrations, click on the On button, then click Turn off auto sync.

Note: Auto-sync won’t run if the Finalise sync step is still displayed. Click Finalise sync to finish setup.

Troubleshooting & FAQs


If the fixes below don't resolve your issue, reply with "Ask a Person" in a support conversation to speak with a Product Support Specialist.

General Data Integrity & Import Management

The first step when investigating any data issue is to check the Import Summary Screen for your most recent import.

  1. Go to Settings > Employee Data > Import History.

  2. Select your most recent import to view details.

This screen provides information on the state of your integration, any specific errors, or will prompt you to run a manual sync to identify problems.

Employment Hero: Integration-Specific Errors

Issue

Cause

Suggested Fix

Employee ID is Blank for Users

The default setting for the integration does not automatically select the unique Employee Identifier that you use in Employment Hero. This is a technical mapping quirk, even though the data is present in your system.

Contact Support for Custom Mapping. The field most often required is your Employee Code. This issue requires a specialist to apply a back-end configuration change to map your EmploymentHero Employee Code to Culture Amp's Employee ID field. Please reply with "Ask a Person" in a support conversation for assistance.

Unable to Exclude Specific Employees

Employment Hero does not support a native "Exclusion" toggle or custom exclusion field that is readable via the API.

Workaround: Use Culture Amp’s bulk deactivation feature to exclude users. Refer to the Excluding Employees (Optional) section for detailed steps.

Missing Data/403 Errors

The connecting API user lacks required Read Access to the necessary API endpoints.

Verify Permissions: Ensure the user has read access to all required objects (/people, employment_histories, etc.) as outlined in the Access and Permissions table.

Manager / Hierarchy is missing for some users

The person listed in the "Reports To" field in Employment Hero does not have a Work Email address on their own profile

Action: Check the "Reports To" field on the employee's file in Employment Hero. Ensure a manager is assigned and that the manager has a Work Email populated on their own profile

Start/End Dates are missing

The data is missing from the Employment History tab in Employment Hero.

Action: The integration looks at the /employment_histories endpoint. Check the employee's Employment History section in EH. Ensure there is a valid "Start Date" and "Termination Date" (if applicable).

Terminated staff still "Active"

The employee was deleted rather than terminated, or the Termination Date is missing.

Action: Ensure the employee has a Termination Date in their Employment History. If you have removed them, try re-adding the employee with a valid termination date and letting the data sync. Simply deleting a user or removing them from a group will not deactivate them in Culture Amp.

If you are still having trouble, reach out to our Culture Amp Support team (via "Ask a Person") to request a manual sync to process the deactivation.

Need to Edit/Delete Mappings

Mappings are locked in the Culture Amp platform once set up. Adding or editing custom mappings often requires a full back-end sync to be triggered by our Culture Amp support team for the changes to be reflected in the platform.

Contact Culture Amp Support:

  • Reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.

  • Please be ready to provide the values of the fields you'd like to map, edit or delete.

  • The change must be made by a specialist, and a full system re-sync may be required to reflect the change.

Switching From CSV or Other Imports

If you are moving from CSV uploads or a different integration, keep the following in mind:

  • Demographic Consistency: When mapping fields, you must map the data to the exact same demographic field you used historically (e.g., mapping to "TEAM" is different from mapping to "TEAM NAME"). Using an incorrect or slightly different title risks discontinuity in your trended survey results.

  • Recommended Action: To avoid confusion, we recommend navigating to Settings > Employee Data Demographics and deleting the old, unused demographics after your first successful sync. (This won't impact any previous survey results.)

Handling Duplicate Employees

Culture Amp uses two fields as unique identifiers for user profiles: Email and Employee ID.

  • As long as at least one of these remains consistent between Employment Hero and Culture Amp, the sync will successfully update the existing profile rather than creating a new one.

  • Duplicate Risk: If you change both the Email and the Employee ID simultaneously in Employment Hero, the sync will not find a match and will create a duplicate profile.

If you see a duplicate profile error flag during your import, take the following steps:

Scenario

Action to Take

A. Before Changes Are Applied

During the first sync review screen, stop the sync. Update the employee emails in Culture Amp to match those in Employment Hero.

  1. Go to the Culture Amp Users page,

  2. Click on the name of the employee you want to update.

  3. Update their email.

  4. Click Save and Exit to update.

  5. Repeat for all duplicated employees.

  6. Then, retry the integration sync.

B. After Changes Are Applied

To clean up the duplicated profiles:

  1. Go to the Culture Amp Users page,

  2. Locate the newest duplicate profile for that user. Click on the name to open up their profile.

  3. Remove existing Email/Employee ID and assign a fake Email or Employee ID to the user and save.

  4. Deactivate this updated profile.

  5. Update the original user profile to match emails in Employment Hero. This keeps the history on the existing employee record.

Further Guidance

Check out our dedicated support guide for further information on duplicate employee clean-up.

Sync Blocked to Protect Employee Privacy

Your automated daily sync might be blocked if Culture Amp detects a high-risk change for an employee. You will receive an email notification if this occurs.

  • When It Happens: The sync is blocked if a combination of an employee's Name, Date of Birth, or Email is changed simultaneously.

  • Purpose: This prevents one employee from accidentally getting access to another employee's private information (like performance reviews).

  • Fix: If you've intentionally changed the employee's details, you can run a manual sync to push the change through. Go to Settings > Employee Data > Users, click Import data, and select Sync. Culture Amp will guide you through the rest.

Redaction of Sensitive Data

As part of this integration, Culture Amp has the ability to redact sensitive data at your request. If you need any fields to be disabled/redacted for your account, please reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.


💬 Need help? Just reply with "Ask a Person" in a support conversation to speak with a Product Support Specialist.

Did this answer your question?