Employment Hero API Directory

Employment Hero is a comprehensive cloud-based human resources software solution designed to cater to the needs of small and medium-sized businesses. As an all-in-one platform, it centralizes a variety of HR functions, including hiring, HR management, payroll, and employee engagement, making it an essential tool for businesses looking to streamline their HR processes. The software is highly customizable, allowing organizations to create an integrated Human Resource Information System (HRIS) and payroll system that aligns with their specific requirements. This flexibility ensures that businesses can efficiently manage their workforce while focusing on growth and productivity.

One of the standout features of Employment Hero is its ability to manage the entire employee lifecycle. From recruitment and onboarding to payroll, time and attendance, and people management, the platform offers a suite of modules designed to simplify HR tasks. Additionally, Employment Hero can integrate seamlessly with other HR and payroll software, facilitating the handling of employee data such as new hires, salary adjustments, and benefit deductions. This integration capability, particularly through the Employment Hero API, is crucial for businesses aiming to consolidate their HR operations into a single, cohesive system, thereby enhancing efficiency and reducing administrative burdens.

Key highlights of Employment Hero APIs

Employment Hero offers a suite of APIs designed to facilitate seamless integration with its HR and payroll platforms. These APIs enable developers to automate processes, manage employee data, and integrate various HR functionalities into their applications. Below is an overview of the available APIs, their functionalities, authentication methods, and rate limits.

Available APIs and Functionalities:

1. HRIS API:
   • Functionality: Provides access to core HR data, including employee records, organizational information, and related HR functionalities.
   • Use Cases: Automating employee onboarding, updating employee details, and retrieving organizational data.
   • Documentation: Employment Hero API - Australia
2. Payroll API:
   • Functionality: Offers endpoints to manage payroll operations, such as processing payroll, managing deductions, and generating payslips.
   • Use Cases: Automating payroll calculations, integrating with accounting systems, and retrieving payroll reports.
   • Documentation: Employment Hero Payroll API Reference - KeyPay
3. Careers Page API:
   • Functionality: Allows integration of Employment Hero's careers page with an organization's website, ensuring job listings are synchronized.
   • Use Cases: Displaying current job openings on a company's website and automating job posting updates.
   • Documentation: API Reference 1 - Australia

Authentication Methods:

• OAuth 2.0:
  • Employment Hero's APIs primarily use OAuth 2.0 for secure authentication. Developers must register their applications through the Employment Hero Developer Portal to obtain client credentials (Client ID and Client Secret). The authentication flow involves obtaining an access token, which is then used to authorize API requests.
  • Steps:
    1. Register your application in the Developer Portal.
    2. Obtain client credentials.
    3. Authorize the application to receive an authorization code.
    4. Exchange the authorization code for an access token.
    5. Use the access token to authenticate API requests.
  • Reference: API Reference - Australia
• API Key Authentication:
  • Some APIs, like the Careers Page API, utilize API key authentication. Users can generate an API access token within the Employment Hero platform, which is then included in the request headers to authenticate API calls.
  • Reference: API Reference 1 - Australia

Rate Limits:

Employment Hero enforces rate limits to ensure fair usage and maintain system performance. While specific rate limits may vary across different APIs, it's essential to implement error handling for potential rate limiting responses. Developers are advised to consult the respective API documentation or contact Employment Hero support for detailed rate limit information.

Additional Resources:

• Developer Portal: Access to API documentation, client registration, and other developer tools.some text
  • Employment Hero API - Australia
• Payroll API Reference: Detailed documentation for payroll-related API endpoints.some text
  • Employment Hero Payroll API Reference - KeyPay

For comprehensive information and to get started with the Employment Hero API, refer to their official API documentation. Employment Hero Developer

‍

Employment Hero API Endpoints

Organisations

• GET https://api.employmenthero.com/api/v1/organisations : Get Organisations from Employment Hero
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id : Get Organisation Details
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/certifications : Get All Certifications for an Organisation
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/certifications/:id : Get a Certification
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/custom_fields : Get All Custom Fields for an Organisation
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/policies : Get Organisation Policies
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/teams : Get All Teams

Employees

• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees : Get Employees
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:id : Get an Employee
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/bank_accounts : Get Bank Accounts for Employee
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/certifications : Get All Employee Certification Details
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/custom_fields : Get All Employee Custom Fields
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/emergency_contacts : Get Emergency Contact
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/employment_histories : Get Employment History
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/pay_details : Get Employee Pay Details
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/payslips : Get Payslips for Employee
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/superannuation_detail : Get Superannuation Detail
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/tax_declaration : Get Tax Declaration Detail
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/timesheet_entries : Get Timesheet Entries
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/teams/:team_id/employees : Get All Employees of a Team

Leave and Availability

• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/leave_requests : Get Leave Requests
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/leave_requests/:id : Get a Leave Request
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/unavailabilities : List Unavailabilities
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/unavailabilities/:id : Get Unavailability Record by ID

Rostered Shifts

• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/rostered_shifts : List Rostered Shifts
• GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/rostered_shifts/:id : Get Rostered Shift by ID

Authentication

• GET https://oauth.employmenthero.com/oauth2/authorize : Obtain Access Token
• POST https://oauth.employmenthero.com/oauth2/token : Refresh Access Token

‍

Employment Hero API FAQs

How can I access the Employment Hero API?

• Answer: To access the Employment Hero API, you need to have a Platinum subscription or higher. Once subscribed, you can register your application through the Employment Hero Developer Portal to obtain client credentials, including a Client ID and Client Secret. These credentials are necessary for authenticating your API requests using the OAuth 2.0 protocol.
• Source: API Reference - Australia

What authentication method does the Employment Hero API use?

• Answer: The Employment Hero API utilizes the OAuth 2.0 protocol for secure authentication. After registering your application and obtaining client credentials, you will perform an authorization flow to receive an access token. This token must be included in the Authorization header of your API requests.
• Source: API Reference - Australia

Are there rate limits for the Employment Hero API?

• Answer: Yes, Employment Hero enforces rate limits to ensure fair usage and maintain system performance. While specific rate limits are not publicly detailed, it's recommended to implement error handling for potential rate limiting responses and to contact Employment Hero support for detailed rate limit information.
• Source: Employment Hero API - Australia

Can I retrieve employee data using the Employment Hero API?

• Answer: Yes, the Employment Hero API provides endpoints to retrieve employee data. For example, you can use the /v1/employees endpoint to fetch a list of employees. Ensure that your application has the necessary scopes and permissions to access this data.
• Source: API Reference - Australia

Does the Employment Hero API support webhooks for real-time data updates?

• Answer: As of the latest available information, the Employment Hero API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
• Source: Employment Hero API - Australia

Get Started with Employment Hero API Integration

Knit API offers a convenient solution for quick and seamless integration with Employment Hero API. Our AI-powered integration platform allows you to build any Employment Hero API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Employment Hero API.‍

To sign up for free, click here. To check the pricing, see our pricing page.