--- title: "Employment Hero API Directory" url: "http://35.223.47.52/blog/employment-hero-api-directory-yiirat/" date: "2026-08-13T12:59:37+00:00" modified: "2026-08-22T15:12:15+00:00" type: "post" --- # Employment Hero API Directory [Blog](http://35.223.47.52/blog) / [API Directory](http://35.223.47.52/blogs/api-directory/) / Employment Hero API Directory [API Directory](http://35.223.47.52/blogs/api-directory/) · August 13, 2026 Employment Hero API Directory ============================= ![](https://storage.googleapis.com/knit-website-media/2026/08/64c34c8eb1ffc79e7f787ecd_Akshat-3-150x150.png)Akshat Jain 20 min read [](https://www.linkedin.com/sharing/share-offsite/?url=http%3A%2F%2F35.223.47.52%2Fblog%2Femployment-hero-api-directory-yiirat%2F) [](https://twitter.com/intent/tweet?url=http%3A%2F%2F35.223.47.52%2Fblog%2Femployment-hero-api-directory-yiirat%2F&text=Employment%20Hero%20API%20Directory) Table of Contents - [Key highlights of Employment Hero APIs](#key-highlights-of-employment-hero-apis) - [Employment Hero API Endpoints](#employment-hero-api-endpoints) - [Organisation APIs](#organisation-apis) - [Employee APIs](#employee-apis) - [Authorization APIs](#authorization-apis) - [Employment Hero API FAQs](#employment-hero-api-faqs) - [Get Started with Employment Hero API Integration](#get-started-with-employment-hero-api-integration) 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](https://developer.employmenthero.com/) 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](https://developer.employmenthero.com/api-references/) - **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](https://developer.employmenthero.com/) - **Payroll API Reference:** Detailed documentation for payroll-related API endpoints.some text - [Employment Hero Payroll API Reference – KeyPay](https://api.keypay.com.au/australia/guides/Home) For comprehensive information and to get started with the Employment Hero API, refer to their official API documentation. [Employment Hero Developer](https://developer.employmenthero.com/api-references/?utm_source=chatgpt.com) ‍ Employment Hero API Endpoints ----------------------------- ### **Organisation APIs** - **GET https://api.employmenthero.com/api/v1/organisations** : This API retrieves a list of organisations from Employment Hero. The request must include an access token in the Authorization header, which is obtained from the Employment Hero Authorisation Server. The API uses the GET method and the endpoint is https://api.employmenthero.com/api/v1/organisations. The response includes details of each organisation such as its unique identifier, name, creation date, and last update date. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id** : This API endpoint retrieves detailed information about a specific organisation using its UUID. The request requires an Authorization header with a bearer token for authentication. The response includes various details about the organisation such as its name, phone number, country, logo URL, primary address, end of week, typical work day, payroll admin emails, subscription plan, superfund name, employee counts, time zone, and creation date. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/certifications** : This API endpoint retrieves a list of all certifications for a specific organisation identified by the organisation\_id. The request requires an Authorization header with a bearer token for authentication. The response includes a data object containing an array of certification objects, each with an id, name, and status. Pagination details such as items per page, current page index, total pages, and total items are also provided in the response. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/custom\_fields** : This API endpoint retrieves a list of all custom fields for a specific organisation. The request requires an ‘organisation\_id’ as a path parameter and an ‘Authorization’ header with a bearer token. The response includes a data object containing an array of custom field objects, each with details such as id, name, hint, description, type, onboarding status, requirement status, permissions, and options. The response also provides pagination details including items per page, current page index, total pages, and total items. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/policies** : This API endpoint retrieves a list of all policies for a specific organisation identified by the organisation\_id. The request requires an Authorization header with a bearer token for authentication. The response includes a data object containing an array of policy objects, each with details such as id, name, induction status, and creation date. Pagination details such as items per page, current page index, total pages, and total items are also provided. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/teams** : The ‘Get All Teams’ API retrieves an array of all teams associated with a specified organisation. The request requires an ‘organisation\_id’ as a path parameter and an ‘Authorization’ header with a bearer token for authentication. The response includes a ‘data’ object containing an array of team objects, each with an ‘id’, ‘name’, and ‘status’. Additionally, pagination details such as ‘item\_per\_page’, ‘page\_index’, ‘total\_pages’, and ‘total\_items’ are provided. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/leave\_requests** : The Get Leave Requests API retrieves a list of all leave requests for a specified organisation. The request requires an organisation\_id as a path parameter and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of leave request objects, each with details such as id, start\_date, end\_date, total\_hours, comment, status, leave\_balance\_amount, leave\_category\_name, reason, and employee\_id. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/rostered\_shifts** : The ‘List Rostered Shifts’ API allows users to retrieve all rostered shifts accessible by the current user within a specified organisation. The API supports pagination and filtering by various parameters such as date range, shift statuses, location IDs, member IDs, and more. The request requires an organisation ID as a path parameter and an authorization bearer token in the headers. Optional query parameters include from\_date, to\_date, statuses, location\_ids, member\_ids, unassigned\_shifts\_only, and exclude\_shifts\_overlapping\_from\_date. The response includes a list of shifts with details such as start and end times, status, location, member information, and shift swap details. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/unavailabilities** : The List Unavailabilities API retrieves all unavailability records that match the specified conditions for a given organisation. The API requires an organisation ID as a path parameter and supports optional query parameters such as from\_date, to\_date, location\_id, member\_id, item\_per\_page, and page\_index to filter the results. The response includes a list of unavailability records with details such as member ID, description, start and end dates, and recurring patterns. The API uses a bearer token for authorization. ### **Employee APIs** - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees** : The Get Employees API retrieves an array of all employees managed by a specified organisation. The API requires an organisation ID as a path parameter and an authorization bearer token in the headers. The response includes a data object containing an array of employee objects, each with detailed information such as ID, email, name, address, job title, and more. If there are no employees, the array will be empty. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id** : This API endpoint retrieves a specific employee’s details from the Employment Hero platform. It requires the organisation ID and employee ID as path parameters, and an authorization bearer token in the headers. The response includes detailed information about the employee, such as their name, contact details, job title, and associated managers and cost centres. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/bank\_accounts** : This API endpoint retrieves a list of all bank accounts for a specific employee within an organisation. The request requires the organisation\_id and employee\_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of bank account records, each with details such as account name, account number, BSB, amount, and whether it is the primary account. Pagination details such as items per page, page index, total pages, and total items are also provided. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/certifications** : This API endpoint retrieves a list of all certifications assigned to a specific employee within an organisation. The request requires the organisation\_id and employee\_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of certification items, each with details such as certification ID, name, type, expiry date, completion date, status, and any driver problems. The response also includes pagination details like items per page, current page index, total pages, and total items. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/custom\_fields** : This API endpoint retrieves a list of all custom fields for a specific employee within an organisation. It requires the organisation\_id and employee\_id as path parameters and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of employee custom field objects, each with properties such as id, value, name, description, and type. The response also includes pagination details like items per page, current page index, total pages, and total items. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/emergency\_contacts** : This API endpoint retrieves a list of all emergency contacts for a specific employee within an organisation. It requires the organisation\_id and employee\_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of emergency contact objects, each with details such as contact name, contact numbers, relationship, and contact type. Pagination details such as items per page, page index, total pages, and total items are also provided. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/employment\_histories** : This API endpoint retrieves the complete employment history for a specific employee within a given organisation. It requires the organisation\_id and employee\_id as path parameters and an Authorization header with a bearer token for authentication. The response includes an array of employment history records, each containing details such as the position title, start and end dates, and employment type. The response also provides pagination details including items per page, current page index, total pages, and total items. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/pay\_details** : This API endpoint retrieves a list of all pay details for a specific employee within a given organisation. The request requires the organisation\_id and employee\_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of pay details, each with properties such as id, effective\_from, classification, industrial\_instrument, pay\_rate\_template, anniversary\_date, salary, salary\_type, pay\_unit, pay\_category, leave\_allowance\_template, change\_reason, and comments. The response also includes pagination details like item\_per\_page, page\_index, total\_pages, and total\_items. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/payslips** : This API endpoint retrieves a list of all payslips for a specific employee within an organisation. It requires the organisation ID and employee ID as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of payslip records, each with details such as employee name, total deductions, net pay, wages, tax, and other payroll-related information. The response also includes pagination details like items per page, current page index, total pages, and total items. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/superannuation\_detail** : This API endpoint retrieves the superannuation detail for a specific employee within a given organisation. It requires the organisation\_id and employee\_id as path parameters, and an Authorization header with a bearer token. The response includes details such as the fund name, member number, product code, and other relevant superannuation account information. If the employee does not have a superannuation detail, a not found error will be returned. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/tax\_declaration** : The Get Tax Declaration Detail API retrieves the tax declaration details for a specific employee within an organisation. It requires the organisation\_id and employee\_id as path parameters, and an Authorization header with a bearer token. The response includes details such as the employee’s first and last name, tax file number, residency status, and any applicable tax debts. If no tax declaration is found, a not found error is returned. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/employees/:employee\_id/timesheet\_entries** : The Get Timesheet Entries API retrieves a list of all timesheet entries for a specific employee within an organisation. The API requires the organisation ID and employee ID as path parameters. The employee ID can be a specific UUID or ‘-‘ to retrieve timesheets for all employees. Optional query parameters include start\_date and end\_date to filter the timesheet entries by date range. The request must include an Authorization header with a bearer token. The response contains a data object with an array of timesheet entries, each entry includes details such as date, start and end times, status, units, and associated cost centre. - **GET https://api.employmenthero.com/api/v1/organisations/:organisation\_id/teams/:team\_id/employees** : This API retrieves all employees associated with a specific team within a managed organization. It requires the organization ID and team ID as path parameters and an authorization bearer token in the headers. The response includes an array of employee objects, each containing detailed information such as ID, email, name, job title, and more. The response also provides pagination details like items per page, current page index, total pages, and total items. ### **Authorization APIs** - **GET https://oauth.employmenthero.com/oauth2/authorize** : The Obtain Access Token API is used to initiate the OAuth 2.0 authorization process to obtain an access token for accessing private data over the Employment Hero API. The API requires the client ID, redirect URI, and response type as query parameters. The user will be prompted to log in and grant permissions, after which they will be redirected to the specified redirect URI with an authorization code. This code can then be used to obtain the access token. The Employment Hero account used for authorization can only access data within its roles or permissions. - **POST https://oauth.employmenthero.com/oauth2/token** : The Refresh Access Token API is used to obtain a new access token using a refresh token. Access tokens expire after 15 minutes, and this API allows for continuous usage by providing a new access token and a new refresh token, invalidating the previous refresh token. The API requires the client\_id, client\_secret, grant\_type, and refresh\_token as query parameters. The response includes a new access\_token, refresh\_token, token\_type, expires\_in, and scope. Employment Hero API FAQs ------------------------ **Does Employment Hero have an API?** Answer: Yes, Employment Hero provides a REST API for accessing employee, payroll, and HR data programmatically. It covers employee profiles, leave, timesheets, and pay runs, with additional payroll endpoints inherited from Employment Hero’s acquisition of KeyPay in 2022. API access requires a Platinum subscription or higher. [Knit’s unified HRIS API ](/solution-categories/hris)includes Employment Hero alongside 30+ other HR platforms through a single normalised endpoint. **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](https://developer.employmenthero.com/api-references/) **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](https://developer.employmenthero.com/api-references/) **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](https://developer.employmenthero.com/) **What HR data can I sync from Employment Hero?** Answer: Employment Hero’s API exposes employee profiles, employment details, pay rates, leave requests and balances, timesheets, and pay run data. Payroll-specific data — pay slips and tax information — is inherited from the KeyPay acquisition and requires payroll module access. Data availability varies by account tier; not all endpoints are available across all plans. Knit normalises this data into a consistent schema alongside 65+ other HRIS platforms. **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](https://developer.employmenthero.com/api-references/) **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](https://developer.employmenthero.com/) **What are the main challenges of building an Employment Hero API integration?** The main challenges are managing OAuth credentials across multiple customer accounts, handling the mixed API surface inherited from the KeyPay acquisition (which adds payroll-specific endpoints with different patterns), and mapping Employment Hero’s data model to your application’s schema. For multi-tenant SaaS products, running the OAuth consent flow for each new customer adds onboarding friction. Knit manages auth, normalisation, and ongoing maintenance for Employment Hero across all customer tenants through a single integration. **How do I integrate Employment Hero with another payroll system?** Integrating Employment Hero with another system typically involves reading employee and payroll data from Employment Hero’s REST API, mapping it to the target system’s data model, and syncing on a schedule or via events like pay run completion or employee status changes. Knit connects Employment Hero alongside other HRIS platforms like Workday, BambooHR, and Rippling through the same integration, normalising data models so you don’t need to rebuild the logic for each system. 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](https://developers.getknit.dev/docs/employmenthero-usecases). 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](https://dashboard.getknit.dev/signup). To check the pricing, see our [pricing page](/pricing/). --- **Ready to build this integration?** Explore Knit’s [Employment Hero integration](/integration/employment-hero/) or read more about our [Unified HRIS API](/integration-categories/unified-hris-api/). ![](https://storage.googleapis.com/knit-website-media/2026/08/64c34c8eb1ffc79e7f787ecd_Akshat-3-150x150.png)Written by Akshat Jain Coding chaos into innovation and building from zero to scale Keep Reading ------------ ![](https://storage.googleapis.com/knit-website-media/2026/08/blog-banner-green-640x400.png) [Tutorials](http://35.223.47.52/blogs/tutorials/) ### [How to Get Employee Leave Data from Employment Hero API](http://35.223.47.52/blog/how-to-get-employee-leave-data-from-employment-hero-api/) Learn how to get employee leave data from the Employment Hero API using OAuth 2.0. Step-by-step guide with endpoints, code… August 13, 2026 · 4 min read ![](https://storage.googleapis.com/knit-website-media/2026/08/blog-banner-yellow-scaled-640x400.png) [API Directory](http://35.223.47.52/blogs/api-directory/) ### [Get Started with Darwinbox API: Complete Integration Guide](http://35.223.47.52/blog/a-to-z-of-integrating-with-darwinbox-api/) Solve all your doubts about integrating with Darwinbox API with this guide August 13, 2026 · 4 min read ![](https://storage.googleapis.com/knit-website-media/2026/08/blog-banner-green-640x400.png) [API Directory](http://35.223.47.52/blogs/api-directory/) ### [Get Started with SuccessFactors API](http://35.223.47.52/blog/get-started-with-successfactors-api/) Read this before you integrate with SuccessFactors API. We've got you all covered from endpoints to SuccessFactors API use cases… August 13, 2026 · 3 min read \#1 in Ease of Integrations --------------------------- ![4.9 out of 5 stars](/wp-content/themes/knit/assets/images/g2/g2-star-rating.svg) 4.9 out of 5 stars on G2 ![G2 Leader, Spring 2026](/wp-content/themes/knit/assets/images/g2/g2-leader.svg)![G2 Fastest Implementation, Spring 2026](/wp-content/themes/knit/assets/images/g2/g2-fastest-implementation.svg)![G2 High Performer, Spring 2026](/wp-content/themes/knit/assets/images/g2/g2-high-performer.svg)![G2 Best Est. ROI, Spring 2026](/wp-content/themes/knit/assets/images/g2/g2-best-roi.svg) Put Integrations on Autopilot. Talk to Experts. ----------------------------------------------- Knit is loved by customers across the globe due to our seamless product and white glove support. You'll love us too! [Talk to a Human](/book-demo)