How can we help you?

What data can be shared via enableHR's Open API?

Follow

The enableHR API Ecosystem

Building an OpenAPI is a huge undertaking, so we’re releasing it in stages. Each release improves and expands the number of things you and your business can do with enableHR.

There are still several months of work ahead for the team to further extend the functionality in our API, but we’re excited about what we’ve achieved so far – and what you can build on today. 

The table below shows the information that is currently exposed through the API and short-term roadmap.

Currently available:

  • Accounts: List Branches
  • Accounts: Retrieve details of a Branch
  • Accounts: List Reference Data: Genders
  • Accounts: List Reference Data: Honorifics
  • Accounts: List Reference Data: Employment Types
  • Accounts: List Reference Data: Employment Status


Employee:

  • Employees: List all employees in the account
  • Employees: Create a new employee
  • Employees: Update an existing employee
  • Employees: Retrieve details of an employee
  • Employees: Terminate an employee
  • Employees: Transfer an employee (Move Everything)

Candidate:

  • Candidates: List all candidates
  • Candidates: Retrieve details of a candidate
  • Candidates: Add new candidate
  • Candidates: Update candidate details
  • Candidates: Convert candidate to employee
  • Candidates: Merge two candidates

Payroll:

  • Payroll (AU & NZ): Retrieve Tax Details to an employee record
  • Payroll (AU & NZ): Maintain Tax Details to an employee record
  • Payroll (AU &NZ): Retrieve details of all Bank Accounts of an employee
  • Payroll (AU & NZ): Maintain Bank Accounts of an employee
  • Payroll (AU & NZ): Retrieve leave balances of an employee
  • Payroll (AU & NZ): Maintain leave balances of an employee
  • Payroll (AU & NZ): Retrieve Retirement Savings of an employee - Superannuation & Kiwisaver
  • Payroll (AU & NZ): Maintain Retirement Savings of an employee - Superannuation & Kiwisaver
  • Payroll (AU & NZ): Retrieve Payroll Details of an employee record
  • Payroll (AU & NZ): Maintain Payroll Details of an employee record

Training & Qualifications:

  • Accounts: List all Competencies
  • Accounts: Create a Competency
  • Accounts: Retrieve details of a Competency
  • Accounts: Update details of a Competency
  • Accounts: Delete a Competency
  • Accounts: Assign a Competency to a Role
  • Employees: List all Competencies allocated to an employee
  • Employees: Allocate a Competency to an employee
  • Employees: Retrieve details of a Competency for an employee
  • Employees: Update details of a Competency for an employee
  • Employees: Unassign a Competency from an employee
  • Accounts: List all Roles
  • Accounts: Retrieve details about a Role
  • Accounts: Create a Role
  • Accounts: Update a Role
  • Accounts: Delete a Role
  • Employees: Allocate a Role to an employee
  • Employees: Unassign a Role from an employee
  • Accounts: List all Groups
  • Accounts: Create a Group
  • Accounts: Retrieve details about a Group
  • Accounts: Update a Group
  • Accounts: Delete a Group

 

Coming soon

  • Employees: List & retrieve notes for an employee
  • Employees: Add & update note to an employee
  • Employees: List/Retrieve/Update Custom Fields of an employee
  • Employees: Check for duplicate employee records
  • Employees: Merge 2 employees
  • Employees: Multi-branch linking of an employee
  • Employees: List & retrieve notes for a candidate
  • Employees: Add a note to a candidate
  • Employees: Transfer to new branch (new copy)
  • Employees: Transfer to new branch (move no trace)
  • Employees: Delete an employee
  • Candidates: Retrieve & update custom fields
  • Candidates: Multi-branch linking of a candidate
  • Candidates: Delete a candidate
  • Users: List and manage ESS users
  • Users: List and manage enableHR users

For background on the meaning of an Open API and how it works, please see this article:  Definitions: What is an Open API? What is an API Connector?

Have more questions? Submit a request

Comments