To build custom integrations or automate data syncing between Employment Hero and your third-party tools, you can utilise our API (Application Programming Interface) and self-service Developer Portal.
For full technical specifications, authentication protocols, and endpoint details, please visit our dedicated documentation:
Subscription Requirements
API access and the Developer Portal are restricted to specific subscription tiers. To use these features, your organisation must be on one of the following plans:
- Platinum HR
- eOS Plus
- eOS Unlimited
Note: Organisations on Lite or Standard Plus plans will not have access to API credentials or the Developer Portal. To upgrade your plan, please contact your Account Manager or navigate to your Billing settings.
Who can access the Developer Portal
Platform admins can access the Developer Portal by default. To give other users access, create a security group:
- Go to Settings and select Permissions.
- Select + Add Permission to create a new group, or open an existing one.
- On the General Permissions step, select API - Access to Developer Portal.
- Select Next, then save the security group.
Members of the group can then access the Developer Portal as described below, subject to the subscription requirements above.
To learn more about permissions, see Grant any custom access needs with Permissions.
How to access the Developer Portal (Self-Service)
If you are on a supported plan, you can manage your own API applications through the platform's self-service portal:
- Log in to your Employment Hero HR platform.
- Click on your Profile Name in the top right-hand corner.
- Select Developer Portal from the dropdown menu.
- From here, you can register a new application to generate your Client ID and Client Secret.
You can change an app's scopes after you create it, from the Edit Application page. The scope picker is searchable and grouped by category, and you'll be asked to confirm before a scope change is saved. Saving a scope change revokes all of the app's active access and refresh tokens straight away, so connected integrations will need to re-authorise before they can continue. Changes to the app name or redirect URI don't revoke tokens.
What can I do in the Developer Portal?
The Developer Portal allows you to handle your integration flow without needing manual intervention from our support team:
- OAuth 2.0 Management: Create and manage secure credentials for your integrations.
- Webhook Configuration: Set up real-time data alerts (e.g., triggering an action when an employee is onboarded).
- Access Scopes: Define exactly what data your integration can read or write.
Technical Resources
For developers looking to start building, please refer to our dedicated developer site:
- Employment Hero API References – Comprehensive technical documentation and authentication guides.
- Payroll API Reference – Specific documentation for payroll-related integrations.