How do I find my API key | Payroll FAQ


How do I find my payroll platform API key?


Payroll Plan:   Standard   Premium


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.


This is valid for payroll subscribers only.

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 API key
  1. Log into your Employment Hero Payroll platform.
  2. Click the Account   menu.
  3. Click the My Account submenu.
  4. Click the Account Details button.

    Helpful Hint

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

    Screenshot of my profile in your payroll account highlighted where to see your unique api key.

Author recommended

So you have now found your API Key and you are now wondering what next can I do. There are two recommendations I would make on this front and they are:

Was this article helpful?
0 out of 1 found this helpful



Please sign in to leave a comment.