How do I find my API key

Andrew

Updated 26 July 2024 05:07

Question

How do I find my payroll platform API key?

Answer

We have implemented our payroll API as a vanilla XML/JSON over HTTP and uses basic HTTP authentication. To use the API, you need to use your API Key, which you can find on the Account Details page.

Helpful Hint

Each user intending to access the API should generate their own API Key. We base the access for a particular API Key on the access of the user who generates it. As a result, providing others with your API Key is essentially the same as providing your email/password to others.

Access my API key

Log into your Employment Hero Payroll platform.
Click the Account menu.
Click the My Account submenu.
Click the Account Details button.

Helpful Hint

You will find your payroll platform API key in the API Key field.

Further information

Are there any additional costs associated with using the API?

There are no additional costs associated with using the API.

Where can I find more information about the API?

For additional information on the API, please refer to our API Documentation.

Explore related content

Managing My Account Details This feature covers how you can update your payroll account email and password, plus edit your payroll account details.
Managing My Two-Factor Authentication Settings This feature allows you to set up your two-factor authentication login details for your payroll account.