Available for the following plans: Employment Unlimited
Available for the following HR plans: Platinum
Available for the following user access level: Admin
Question
How can I use the Employment Hero Application Programming Interface (API) to connect my software systems?
Answer
An API acts as a secure translator that allows different software systems to communicate and share data in real-time. By using our API, you can automate manual workflows and reduce the risk of double-entry errors.
Common Use Cases:
- Recruitment Integration: Automatically create a new employee profile in Employment Hero as soon as a candidate is marked as "Hired" in your external Applicant Tracking System (ATS).
- Time & Attendance: Sync approved hours from an external clock-in device directly into Employment Hero for payroll processing.
Our API provides a powerful, two-way connection for your data. This allows your integrated tools to not only retrieve information from your platform but also write or push back into it in real-time.
Available API Endpoints:
- Employee Lifecycle: Create, view, and update employee records.
- Time Off Management: Create and view time off requests.
- Time and Attendance: Create and manage timesheets.
- Check for an existing integration: Before building something new, check if a pre-built connection already exists. Review our Canada Integrations Page for a full list of third-party connectors and direct integrations.
- Contact your software provider: If you use a specific third-party tool, ask them if they have an existing integration with Employment Hero or if they can build one using our endpoints.
-
Build a custom integration: If you require a bespoke solution, you can hire a developer (in-house or external) to build a custom connection.
-
Documentation: Technical specs are available at developer.employmenthero.com.
- In our API references documentation, you can filter by region to see only the API request and response fields that are relevant to employees in that region. Changing the language in the bottom left updates non-endpoint documentation terms to mirror the language used in the platform.
-
Access: Your developer will need to be added as an Admin within your EH platform to build and test the connection.
-
Documentation: Technical specs are available at developer.employmenthero.com.
Important: Our Support Policy
While Employment Hero provides the API infrastructure, we are not responsible for building, testing, or troubleshooting custom or third-party integrations. The responsibility for maintaining the integration rests with your organization and your chosen developer.