# Employment Hero Ess API

**Canonical:** https://apis.io/apis/employment-hero/employment-hero-ess-api/  
**Provider:** Employment Hero — https://apis.io/providers/employment-hero/  
**Base URL:** https://api.employmenthero.com/api/v1  
**Documentation:** https://developer.employmenthero.com/api-references

Employment Hero Ess API is one of 79 APIs that [Employment Hero](https://apis.io/providers/employment-hero/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Ess. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Employee Self Setup

## Operations (60 of 127)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v2/ess/devicetoken/register` | Register Device Token |
| POST | `/api/v2/ess/devicetoken/unregister` | Unregister Device Token |
| GET | `/api/v2/ess/security/employees` | Get Employees |
| POST | `/api/v2/ess/security/forgottenpassword` | Recover Forgotten Password |
| GET | `/api/v2/ess/{employeeId}/bankaccounts` | List Bank Accounts |
| POST | `/api/v2/ess/{employeeId}/bankaccounts` | Create Bank Account |
| GET | `/api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}` | Get Bank Account by ID |
| DELETE | `/api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}` | Delete Bank Account |
| PUT | `/api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}` | Update Bank Account |
| PUT | `/api/v2/ess/{employeeId}/bankaccounts/{id}` | Update Bank Account |
| GET | `/api/v2/ess/{employeeId}/dashboard` | Get Dashboard |
| POST | `/api/v2/ess/{employeeId}/details` | Save Details |
| GET | `/api/v2/ess/{employeeId}/details` | Get Details |
| GET | `/api/v2/ess/{employeeId}/document` | List all Documents |
| POST | `/api/v2/ess/{employeeId}/document/acknowledge/{documentId}` | Acknowledge Document |
| GET | `/api/v2/ess/{employeeId}/document/download/{documentId}` | Download Document |
| GET | `/api/v2/ess/{employeeId}/document/paymentsummaries` | Get Payment Summaries |
| GET | `/api/v2/ess/{employeeId}/document/paymentsummary/{documentId}` | Get Payment Summary PDF |
| GET | `/api/v2/ess/{employeeId}/document/payslip` | List Pay Slips |
| GET | `/api/v2/ess/{employeeId}/document/payslip/{payrunId}` | Get Pay Slip by Pay Run ID |
| GET | `/api/v2/ess/{employeeId}/document/{documentId}` | Get Document Details by ID |
| GET | `/api/v2/ess/{employeeId}/emergencycontacts` | Get Emergency Contacts |
| POST | `/api/v2/ess/{employeeId}/emergencycontacts` | Save Emergency Contacts |
| PUT | `/api/v2/ess/{employeeId}/emergencycontacts` | Update Emergency Contacts |
| GET | `/api/v2/ess/{employeeId}/expense` | Get Expense Requests |
| POST | `/api/v2/ess/{employeeId}/expense` | Create Expense Request |
| GET | `/api/v2/ess/{employeeId}/expense/categories` | Get Expense Categories |
| GET | `/api/v2/ess/{employeeId}/expense/summary` | Get Expense Payment Summary |
| GET | `/api/v2/ess/{employeeId}/expense/taxcodes` | Get Tax Codes |
| GET | `/api/v2/ess/{employeeId}/expense/{expenseRequestId}` | Get Expense Request by ID |
| PUT | `/api/v2/ess/{employeeId}/expense/{expenseRequestId}` | Update Expense Request |
| DELETE | `/api/v2/ess/{employeeId}/expense/{expenseRequestId}` | Delete Expense Request |
| PUT | `/api/v2/ess/{employeeId}/expense/{expenseRequestId}/attachment` | Upload Attachment to Expense Request |
| GET | `/api/v2/ess/{employeeId}/leave` | List Leave Requests |
| POST | `/api/v2/ess/{employeeId}/leave` | Create Leave Request |
| GET | `/api/v2/ess/{employeeId}/leave/balances` | Get Leave Balances |
| GET | `/api/v2/ess/{employeeId}/leave/estimate` | Estimate Leave Hours |
| GET | `/api/v2/ess/{employeeId}/leave/leavecategories` | Get Leave Categories |
| GET | `/api/v2/ess/{employeeId}/leave/{leaveRequestId}` | Get Leave Request by ID |
| POST | `/api/v2/ess/{employeeId}/leave/{leaveRequestId}` | Update Leave Request |
| DELETE | `/api/v2/ess/{employeeId}/leave/{leaveRequestId}` | Delete Leave Request |
| PUT | `/api/v2/ess/{employeeId}/leave/{leaveRequestId}/attachment` | Upload Attachment to Leave Request |
| DELETE | `/api/v2/ess/{employeeId}/leave/{leaveRequestId}/attachment` | Delete Attachment from Leave Request |
| GET | `/api/v2/ess/{employeeId}/lookup/location` | Get Locations |
| GET | `/api/v2/ess/{employeeId}/lookup/shiftcondition` | Get Shift Conditions |
| GET | `/api/v2/ess/{employeeId}/lookup/suburb` | Get Suburb |
| GET | `/api/v2/ess/{employeeId}/lookup/suburbs` | Search Suburbs |
| GET | `/api/v2/ess/{employeeId}/lookup/title` | Get Titles |
| GET | `/api/v2/ess/{employeeId}/lookup/worktype` | Get Work Types |
| PUT | `/api/v2/ess/{employeeId}/personaldetails` | Update Personal Details |
| GET | `/api/v2/ess/{employeeId}/personaldetails` | Get Personal Details |
| GET | `/api/v2/ess/{employeeId}/profileimage` | Get Employee Profile Image |
| POST | `/api/v2/ess/{employeeId}/profileimage` | Set Employee Profile Image |
| DELETE | `/api/v2/ess/{employeeId}/profileimage` | Delete Employee Profile Image |
| GET | `/api/v2/ess/{employeeId}/publicHolidays` | Get public holidays |
| GET | `/api/v2/ess/{employeeId}/qualification` | Get Qualifications for Employee |
| POST | `/api/v2/ess/{employeeId}/qualification` | Add Employee Qualification |
| PUT | `/api/v2/ess/{employeeId}/qualification/{employeeQualificationId}/attachment` | Upload attachment to qualification |
| DELETE | `/api/v2/ess/{employeeId}/qualification/{employeeQualificationId}/attachment/{documentId}` | Delete attachment from EmployeeQualification |
| GET | `/api/v2/ess/{employeeId}/qualification/{id}` | Get Qualification Details |

…and 67 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-ess-api-openapi.yml
- **Documentation** — https://api.keypay.com.au/guides/Home.html
- **APIReference** — https://api.keypay.com.au/
- **APIReference** — https://api.keypay.com.au/new-zealand/reference.html
- **APIReference** — https://api.keypay.com.au/united-kingdom/reference.html
- **APIReference** — https://api.keypay.com.au/singapore/reference.html
- **APIReference** — https://api.keypay.com.au/malaysia/reference.html

## Other Employment Hero APIs (12)

- [Employment Hero REST API](https://apis.io/apis/employment-hero/rest-api/)
- [Employment Hero Bank Accounts API](https://apis.io/apis/employment-hero/employment-hero-bank-accounts-api/)
- [Employment Hero Certifications API](https://apis.io/apis/employment-hero/employment-hero-certifications-api/)
- [Employment Hero Cost Centres API](https://apis.io/apis/employment-hero/employment-hero-cost-centres-api/)
- [Employment Hero Custom Fields API](https://apis.io/apis/employment-hero/employment-hero-custom-fields-api/)
- [Employment Hero Departments API](https://apis.io/apis/employment-hero/employment-hero-departments-api/)
- [Employment Hero Documents API](https://apis.io/apis/employment-hero/employment-hero-documents-api/)
- [Employment Hero Emergency Contacts API](https://apis.io/apis/employment-hero/employment-hero-emergency-contacts-api/)
- [Employment Hero Employees API](https://apis.io/apis/employment-hero/employment-hero-employees-api/)
- [Employment Hero Forms API](https://apis.io/apis/employment-hero/employment-hero-forms-api/)
- [Employment Hero Job Histories API](https://apis.io/apis/employment-hero/employment-hero-job-histories-api/)
- [Employment Hero Aba Settings API](https://apis.io/apis/employment-hero/employment-hero-abasettings-api/)

## Tags

Ess

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/employment-hero/employment-hero-ess-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/employment-hero/.