API

What is an API?

Our application program interface (API) lets other programs create and retrieve data in your payroll database.

For example, you might have your own attendance system or HR package and want to create or retrieve information from your payroll system, such as:

• QueryStaff retrieve employee information

• AddStaff create a new employee

• UpdateStaff update an employee record

• QueryLeave get employee leave balance and entitlement information

• AddTime create a timesheet entry

How does it work?

We provide you with an "API Key" which is a unique identifier that allows access to your database and is required in every request to the API.

It's just a code that looks like this example: 7D0E0B3EAA.....AF74E51B01D1188 (middle bit removed)

The API Key is available from your Profile > API Details menu option in the app (available to the site owner only).

This looks like a job for a programmer?

Not necessarily...

If you wish to use the native API provided, then yes, you probably need to have a programmer set up the integration for you (it's not difficult, but it's also not a job for the inexperienced). Your programmer developing the integration will need this guide.

However, we also provide API access via Zapier, allowing you to connect thousands of applications - and it's free for up to 1,000 "Zaps" per month.

What is Zapier?

Zapier provides an API aggregator that lets you connect to thousands of other applications without programming - and it's free for up to 1000 "Zaps" per month!

Zapier lets you connect say an event that notifies a new employee has been created in your HR system to then automatically create that employee in our app, or to create a timesheet entry, or watch an employee's leave balances and get emailed a summary each month. All pretty cool really and no programmer required! The only thing is that the application you want to integrate with is listed on Zapier and it needs to have events that map to actions available in the interface.