Skip to main content
Administrator access to the platform, or access to the necessary modules via Permissions, is required to use Admin API scopes.

​
Register an OAuth application

Create an application in the Employment Hero Developer Portal to obtain the OAuth credentials for API access.

1

Sign in to Employment Hero

Sign in to your Employment Hero account.

The Employment Hero sign-in page with the Email field highlighted
2

Open the Developer Portal

Click your profile name in the top right corner and select Developer Portal from the menu.

The profile menu open with the Developer Portal item highlighted
3

Add a new application

On the API page, click Add Application.

The Developer Portal API page with the Add Application button highlighted
4

Fill in application details

On the Add New Application screen, complete the Application Details fields.

  • Application Name: any name you choose — for example, StackOne Integration
  • Redirect URI: https://api.stackone.com/connect/oauth2/employmenthero/callback
The Add New Application form with the Application Name and Redirect URI fields highlighted
5

Select API scopes

Enables actions: Archive Certification, Create Certification, Create Department, Create Employee Salary Version, Create Work Site, Delete Certification, Get Certification, Get Certification Polling Status, Get Employee, Get Employee Superannuation, Get Employee Tax Declaration, Get Form, Get Form Response, Get Leave Request, Get Leave Requests, Get Onboarding Polling Status, Get Organisation, Get Rostered Shift, Get Unavailability, List Certifications, List Contractor Job Histories, List Cost Centres, List Custom Fields, List Employee Bank Accounts, List Employee Certifications, List Employee Custom Fields, List Employee Documents, List Employee Emergency Contacts, List Employee Employment Histories, List Employee Pay Details, List Employee Payslips, List Employees, List Employing Entities, List Form Responses, List Forms, List Leave Categories, List Organisations, List Policies, List Rostered Shifts, List Team Employees, List Teams, List Timesheet Entries, List Unavailabilities, List Work Locations, List Work Sites, Onboard Employee, Quick Add Contractor, Quick Add Employee, Update Certification, Update Department, Upload Certification Files, Upload Employee Document

In the API Scopes section, enable the permissions this integration needs. Each resource has its own Read, Create, Update, and Delete toggles, and StackOne only calls the endpoints your scopes allow. Enable the following:

The API Scopes section with the Read scope selected for the Employees resource
6

Check the scopes before saving

Employment Hero locks an application’s scopes the moment it is saved, so confirm the selection is complete before continuing.

  • Use the Search scopes… box to find a resource quickly — scope groups are named after the resource, so search for “employee” or “leave” to narrow the list.
  • Scopes cannot be changed after the application is saved. Adding one later means registering a new application and reconnecting the account, so enable everything the integration may need now rather than the minimum.
  • Read-only integrations can safely skip every Create, Update, and Delete toggle.
7

Review and create the application

Click Continue to Review, check the Application Details and Selected Scopes, then click Create Application.

The Review Application Details screen with the Create Application button highlighted
8

Copy your API credentials

On the Application Created Successfully! screen, use the Copy buttons to copy the Client ID and Client Secret. Store both securely for use later.

  • Store these credentials securely. Do not share your credentials.
  • Paste them into the Client ID and Client Secret fields in the StackOne Connector profile.
The API Credentials screen with the Copy buttons for Client ID and Client Secret highlighted

​
Creating the StackOne Connector Profile

To create the Connector Profile in StackOne for Employment Hero:
1

Navigate to Connector Profiles

Login to StackOne and navigate to Connector Profiles
2

Create New Connector Profile

  • Click + Connector Profile
  • Search for and select Employment Hero
  • Select Type as OAuth 2.0
  • Fill out the fields using details retrieved from your provider:
    • Client ID
    • Client Secret
  • (Optional) Select Actions to be enabled for this Connector Profile
  • Click Create profile
Congratulations! The new Connector Profile will now show up in your project ready to be used. You can now continue to Link Accounts for Employment Hero.