# Employment Hero Employee API

**Canonical:** https://apis.io/apis/employment-hero/employment-hero-employee-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 Employee 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 Employee. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

## Operations (60 of 103)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v2/business/{businessId}/employee/activate/{employeeId}` | Activate Employee |
| GET | `/api/v2/business/{businessId}/employee/details` | List basic details for employees |
| POST | `/api/v2/business/{businessId}/employee/grantkioskaccess/{employeeId}` | Grant Kiosk Access |
| POST | `/api/v2/business/{businessId}/employee/revokekioskaccess/{employeeId}` | Revoke Kiosk Access |
| POST | `/api/v2/business/{businessId}/employee/unstructured` | Create or Update Employee |
| GET | `/api/v2/business/{businessId}/employee/unstructured` | List Employees |
| GET | `/api/v2/business/{businessId}/employee/unstructured/externalid/{externalId}` | Get Employee By External ID |
| GET | `/api/v2/business/{businessId}/employee/unstructured/externalreferenceid/{externalreferenceid}/{source}` | Get Employee By External Reference ID |
| GET | `/api/v2/business/{businessId}/employee/unstructured/{employeeId}` | Get Employee By ID |
| PUT | `/api/v2/business/{businessId}/employee/unstructured/{employeeId}` | Update Employee |
| DELETE | `/api/v2/business/{businessId}/employee/{employeeId}` | Delete Employee |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/details` | Get Employee basic details by ID |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/image` | Get Employee Profile Image |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/image` | Set Employee Profile Image |
| DELETE | `/api/v2/business/{businessId}/employee/{employeeId}/image` | Delete Employee Profile Image |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/leavebalances` | Get Leave Balances |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/notes` | Get Employee Notes |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/notes` | Set Employee Notes |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/openingbalances` | Get Opening Balances |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/openingbalances` | Set Opening Balances |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/payrate` | Get Pay Rates |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/shiftcondition` | Get Employee Shift Conditions |
| PUT | `/api/v2/business/{businessId}/employee/{employeeId}/standardhours` | Set standard hours for employee |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/standardhours` | Get standard hours for employee |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/worktype` | Get Employee Work Types |
| GET | `/api/v2/business/{businessId}/employee` | Get Employee By External ID |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms` | Gets hmrc forms view model for employee |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/autoenrolmentnotice` | Create auto enrolment notice |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/downloadautoenrolmentnotice` | Download Auto Enrolment Notice |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/emailautoenrolmentnotice/{noticeId}` | Send auto-enrolment notification to employee |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/mailp45` | Send P45-email to employee |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p11ddownload/{taxYear}` | Download Employee P11D form |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p45` | Get P45 model for employee |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p45data` | Get P45 Data |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p45download` | Download P45 |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p60/{financialYearEnding}` | Get P60 model for employee |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p60download/{financialYearEnding}` | Download P60 |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/hmrcforms/p60notify/{noticeId}/{financialYearEnding}` | Notify employee by email of P60 |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancebackcalculation` | Get National Insurance Back Calculation of employee |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancebackcalculation` | Apply National Insurance Back Calculation |
| DELETE | `/api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancebackcalculation` | Delete National Insurance Back Calculation |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancebackcalculation/calculation` | Back calculate National Insurance |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord` | Get National Insurance Record and P45 |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord` | Create National Insurance Record and P45 |
| PUT | `/api/v2/business/{businessId}/employee/{employeeId}/nationalinsurancerecord` | Update National Insurance Record and P45 |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/occupationalabsence` | Create Occupational Absence |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/occupationalabsence` | Get Occupational Absence |
| PUT | `/api/v2/business/{businessId}/employee/{employeeId}/occupationalabsence/{id}` | Update Occupational Absence |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/pension` | Get Pension Contribution Plan |
| PUT | `/api/v2/business/{businessId}/employee/{employeeId}/pension` | Update Pension Contribution Plan |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/pension/force` | Force Enrolment |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sap` | Create Statutory Adoption Leave Period data |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sap/{ukStatutoryAdoptionLeaveDataId}/attachments` | Get Statutory Adoption Leave Attachments |
| PUT | `/api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sap/{ukStatutoryAdoptionLeaveDataId}/employeedocument/{employeeDocumentId}` | Attach Employee Document to Statutory Adoption Leave |
| DELETE | `/api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sap/{ukStatutoryAdoptionLeaveDataId}/employeedocument/{employeeDocumentId}` | Unattach Employee Document from Statutory Adoption Leave |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sapcalc` | Calculate Statutory Adoption Leave Period Data |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp` | Get Statutory Shared Parental Leave Period Data |
| POST | `/api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp` | Create Statutory Shared Parental Leave Period data |
| GET | `/api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{ukStatutoryMaternityLeaveDataId}` | Get Statutory Shared Parental Leave Period Data By Id |
| PUT | `/api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{ukStatutoryMaternityLeaveDataId}` | Update Statutory Shared Parental Leave data |

…and 43 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-employee-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

Employee

---

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