Employment Hero’s HR API: What, why, how?

So first things first – what’s an API and how will it make my life easier?

What is an application programming interface (API)?

An application programming interface (aka API) pushes and translates data from one source to another.

Think of a professional rugby match. The coach is in the coaching box watching over the game. His team gets a penalty and he wants to communicate to the players that they should go for a penalty kick. He radios a trainer on the field, who uses a hand signal to communicate to the players they should take a penalty kick.

In this scenario, Source A is the coach. The API is the trainer, who receives data from Source A and then communicates it to the players (Source B) in a format they can understand.

Why do I need one for people management?

Truth be told, not everyone does. If you’ve kept good data hygiene and can manage your people through a single platform like Employment Hero, an API isn’t super relevant to you.

However, if you manage a large number of employees or have existing platforms in place that can’t be removed, Employment Hero’s HR API and its integration could be incredibly useful. Do any of the following statements sound like you?

‘Every time I onboard a new employee, I have to update three other platforms’

By using the API integration, Employment Hero becomes your source of truth for every integrated platform that relies on employee data. Because employees are responsible for their own personal data (like their address, bank details, certification and work entitlements), you can feel confident that the data being pulled from Employment Hero is accurate.

Transferring this data electronically removes any errors that stem from double data handling or the frustrations that come from broken imports. This benefit becomes more apparent as your business grows and your employee management needs become more complex. 

‘I don’t want to part with an existing system’

We get it. Sometimes a tool works perfectly in your business, or it’s taken so long to train employees to use it, it wouldn’t be worthwhile to rip it out.

An API integration from Employment Hero will pull data into the other system. This means that all the employee data you’ve been supplied with during onboarding can be automatically pushed from Employment Hero to the tool you need it in. 

Plus, we’ve recently introduced write permissions, meaning data from other systems can now be used to update information within the Employment Hero platform. We will be continuously growing our API coverage to make automating and integrating your workflows even easier.

How secure is the integration?

The API is secure and uses a security protocol called OAuth2.0. OAuth2.0 will prevent unauthorised access into Employment Hero’s system. 

However, as you will be using your own network to connect with the API, it will only be as secure as your own network is. Within your own organisation, API-accessible data is limited to certain access levels, so you don’t have to worry that an employee will use an API to get information they aren’t authorised to see.

How can I connect with Employment Hero’s HR API?

The API is available on Platinum HR, eOS Plus and eOS Unlimited subscriptions. The Quickstart Guide and all other documentation can be found here. 

Want to know more about Employment Hero’s HR API?

The best place to start is the HR API documentation, which can be found here. If you have any questions, head to our Help Centre. If you’re looking to upgrade your subscription, submit a request here. 

API is only available on Platinum HR, eOS Plus and eOS Unlimited subscriptions.