About our API

The HR Partner API

An API (Application Programming Interface) is a standard method that different applications use to 'talk' to one another.

HR Partner actually has a complex API already built into the system, and we actually use that API ourselves within the app to generate all the reports in the system.  So we know it is robust and capable.

As at April 2020, we began releasing our API to the public with limited functionality.  At present, our API is mainly 'read only' (though we DO have some write back functionality), and we don't support access to ALL data in our system.  As we improve our API and get feedback from early users, we will be updating and releasing more functionality, so please check back.

API Documentation

We have a separate site for technical documentation for our API, which can be found over at: https://developer.hrpartner.io

Setting Up API Access

Before you can use our API to access data in your HR Partner company, you will have to activate the API so that you can access your company data from any external source (e.g. Zapier).  To do this, you will have to go to Setup -> Configure -> Integrations on the left hand menu.

And on the top of the next screen that comes up, you will have to tick the checkbox which says 'Enable API access for external applications'.

Note: You MUST tick this box to enable external access to your company data.  Similarly, if you want to revoke access to your data from external parties, you can uncheck this box and save your settings, which will prevent anyone from accessing your data.

Your API Token

The above screen also displays your current API Token.  Please keep this token safe.  It is as important as your password.  If anyone gets access to this token, they can access your company data.  If at any time you feel that your company token may be compromised, you can click the 'Reset API Token' button to reset it to a different random token.  If you do this, you will have to update the token in any third party tool that you are using to access your HR Partner data.

Please visit https://developer.hrpartner.io for all technical documentation relating to our API.