Skip to main content

Employment Hero

Employment Hero is an all-in-one HR, payroll, and people management platform designed to simplify the entire employee lifecycle. It provides tools for hiring and onboarding, HR and compliance management, payroll processing, leave and time-off management, timesheets, certifications, and employee engagement—all in a single unified platform. Organisations across Australia, New Zealand, the UK, Malaysia, and Singapore use Employment Hero to automate HR workflows, reduce administrative overhead, and ensure workforce data is always accurate and up to date. The Employment Hero REST API allows external systems to securely access and exchange HR data, enabling integrations with business intelligence tools, data warehouses, and other enterprise applications.

Employment Hero icon

Power end-to-end data operations for your Employment Hero API with Nexla. Our bi-directional Employment Hero connector is purpose-built for Employment Hero, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Employment Hero or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Employment Hero workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

The Employment Hero API uses OAuth 2.0 to authenticate external integrations. Before creating a credential in Nexla, you must register an application in the Employment Hero Developer Portal to obtain your Client ID and Client Secret.

Subscription Requirements​

API access is available on Platinum subscriptions and above. Organisations on Lite or Standard Plus plans will not have access to the Developer Portal or API credentials.

Register an Application in the Employment Hero Developer Portal​

  1. Log in to your Employment Hero HR platform.

  2. Click your Profile Name in the top right-hand corner of the screen.

  3. Select Developer Portal from the dropdown menu.

  4. In the Developer Portal, click the Add Application button to register a new application.

  5. Enter the following details for your application:

    • Application Name: Enter a descriptive name (e.g., Nexla Integration).
    • Redirect URI: Enter the OAuth callback URL for Nexla. Refer to your Nexla instance configuration for the correct callback URL.
    • Scopes: Select the data scopes your integration requires. Common scopes include urn:mainapp:organisations:read and urn:mainapp:employees:read. Grant only the scopes needed for your specific use case.

  6. Click Save to create the application.

  7. On the application details page, locate and copy both the Client ID and Client Secret values. Store these values securely — you will need them when configuring the Nexla credential.

The Client Secret is shown only once after application creation. Copy and store it in a secure location before leaving the page. Additional details about the Developer Portal are available in the Employment Hero API documentation.

Important

All configured OAuth 2.0 scopes for your application are visible in the Developer Portal. Ensure the scopes granted match the data your integration needs to access. Overly broad scopes increase security risk.

Authenticate​

Credentials required​

Authenticate using OAuth 2.0 Authorization Code flow with your Employment Hero application's Client ID and Client Secret.

FieldRequiredSecretDescription
Client IDYesNoThe Client ID from your Employment Hero Developer Portal application registration.
Client SecretYesYesThe Client Secret from your Employment Hero Developer Portal application registration. Keep this value secure.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter the Client ID from your Employment Hero Developer Portal application in the Client ID field. This value identifies your registered application to the Employment Hero authorization server.

  4. Enter the Client Secret from your Employment Hero Developer Portal application in the Client Secret field. This value is used to securely authenticate your application when requesting tokens. Treat the Client Secret as a password — do not share it or expose it in plaintext.

    Employment Hero uses the OAuth 2.0 Authorization Code flow to authenticate API integrations, allowing Nexla to securely request access on behalf of your organisation using the Client ID and Client Secret from your registered Developer Portal application. Access tokens issued by Employment Hero expire after 15 minutes (900 seconds); Nexla automatically handles token refresh using the provided credentials, so your data flows remain uninterrupted.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Employment Hero connector tile, then select the credential that will be used to connect to the Employment Hero instance, and click Next; or, create a new Employment Hero credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Employment Hero endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below; click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Organisations

Retrieves all organisations accessible to the authenticated integration. Use this endpoint to obtain the organisation IDs needed for other Employment Hero endpoints, or to ingest top-level organisation metadata such as name, country, phone number, logo, and primary address.

  • This endpoint does not require any additional configuration parameters. Select it from the Endpoint menu and proceed to testing.
  • Results are returned as a paginated list. Nexla automatically iterates through all pages to retrieve the complete dataset.

Organisation IDs returned by this endpoint are required as input for the List Employees, List Leave Requests, List Certifications, and List Timesheet Entries endpoints. Run this endpoint first to discover the Organisation IDs available to your integration.

List Employees

Retrieves all employees for a specified organisation. Employee records include personal details, employment status, job title, department, start date, and other profile information. Use this endpoint to build workforce rosters, sync employee data to analytics systems, or maintain up-to-date people records.

  • Enter the unique identifier of the organisation whose employees you want to retrieve in the Organisation ID field. You can obtain the Organisation ID using the List Organisations endpoint.
  • Results are paginated and Nexla will automatically retrieve all pages of employee records.

The Organisation ID is a required field. Ensure you have obtained a valid Organisation ID from the List Organisations endpoint before configuring this template. Your OAuth 2.0 application scopes must include urn:mainapp:employees:read to access employee data.

List Leave Requests

Retrieves all leave requests for a specified organisation. Each record includes the leave type, start and end dates, total hours, approval status, and the requesting employee. Use this endpoint to track leave trends, monitor absence patterns, or sync leave data into workforce planning or analytics tools.

  • Enter the unique identifier of the organisation whose leave requests you want to retrieve in the Organisation ID field.
  • Results are paginated and Nexla will automatically retrieve all pages.

Leave request data includes both pending and approved requests. Filter by status within Nexla transforms if you need only approved leave records for downstream analysis.

List Certifications

Retrieves all certifications defined for a specified organisation. Certification records include the certification name, type, expiry date, and status. Use this endpoint to monitor compliance requirements, track employee credential expiry dates, or report on workforce qualifications.

  • Enter the unique identifier of the organisation whose certifications you want to retrieve in the Organisation ID field.
  • Results are paginated and Nexla will automatically retrieve all pages.

Certification data can be combined with employee data to identify employees whose certifications are approaching expiry, enabling proactive compliance management.

List Timesheet Entries

Retrieves all timesheet entries for a specified employee within an organisation. Each record includes clock-in and clock-out times, total hours worked, the associated date, and any associated break times. Use this endpoint to integrate timesheet data into payroll systems, analyse workforce productivity, or audit time-tracking accuracy.

  • Enter the unique identifier of the organisation in the Organisation ID field.
  • Enter the unique identifier of the employee whose timesheet entries you want to retrieve in the Employee ID field. Employee IDs can be obtained from the List Employees endpoint.
  • Results are paginated and Nexla will automatically retrieve all pages.

Both Organisation ID and Employee ID are required fields for this endpoint. To retrieve timesheet entries across all employees in an organisation, use chained data flows — first ingest employees with the List Employees endpoint, then use the resulting Employee IDs as inputs to this endpoint.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Employment Hero data sources can also be manually configured to ingest data from any valid Employment Hero API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

The base URL for all Employment Hero API v1 endpoints is https://api.employmenthero.com/api/v1/. Append the specific resource path, replacing path parameters such as {organisation_id} and {employee_id} with the actual ID values — for example, https://api.employmenthero.com/api/v1/organisations/{organisation_id}/employees.

Employment Hero API responses return a JSON object with a top-level data array containing the resource records, plus pagination metadata. Enter $.data[*] as the Path to Data in Response. The Accept:application/json header is used for JSON responses.

Date/time macros are particularly useful for Employment Hero endpoints that accept date filters, such as filtering leave requests or timesheet entries by date range, enabling incremental data ingestion rather than fetching the entire dataset on each run.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Employment Hero data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Employment Hero destination, and select the Send to Destination option from the menu. Select the Employment Hero connector from the list of available destination connectors, then select the credential that will be used to connect to the Employment Hero organisation, and click Next; or, create a new Employment Hero credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Employment Hero endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

List Employees

Sends employee record data to an Employment Hero organisation endpoint. Use this template to create or update employee records in Employment Hero from an external source, enabling automated onboarding workflows or employee data synchronisation.

  • Enter the unique identifier of the target Employment Hero organisation in the Organisation ID field. This determines which organisation the employee records will be written to.
  • Ensure the Nexset data fields are mapped to the correct Employment Hero employee fields before activating the destination. Use Nexla's field mapping and transformation tools as needed.

Your OAuth 2.0 application scopes must include write permissions for employee data. Verify that the appropriate scopes are configured in the Employment Hero Developer Portal before attempting to write data. Refer to the Employment Hero API documentation for the complete list of writable employee fields and required formats.

List Leave Requests

Sends leave request data to an Employment Hero organisation endpoint. Use this template to submit or update leave requests in Employment Hero from an external scheduling or HR system.

  • Enter the unique identifier of the target Employment Hero organisation in the Organisation ID field.
  • Ensure that the leave request fields in your Nexset — including leave type, start date, end date, employee ID, and status — are correctly mapped to Employment Hero's expected request format.

Leave request submissions require valid employee IDs. Ensure employee IDs in your Nexset match those in Employment Hero before activating the destination.

Manual configuration​

Employment Hero destinations can also be manually configured to send data to any valid Employment Hero API endpoint. Using manual configuration, you can also configure Nexla to automatically send the response received from the Employment Hero API after each call to a new Nexla webhook data source. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The base URL for all Employment Hero API v1 endpoints is https://api.employmenthero.com/api/v1/ (for example, https://api.employmenthero.com/api/v1/organisations/{organisation_id}/employees to write employee records to a specific organisation); for update/upsert operations, include the ID of the object to be updated at the end of the URL. The Employment Hero API accepts JSON-encoded request bodies — select JSON as the Content Format. Use POST for creating new records and PUT or PATCH for updating existing records.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Employment Hero endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to Employment Hero until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.