Employment Hero

Employment Hero Employee API

Employee

GitHub OpenAPI

Operations 103

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 #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{ukStatutoryMaternityLeaveDataId}/attachments Get Statutory Shared Parental Leave Attachments #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{ukStatutoryMaternityLeaveDataId}/employeedocument/{employeeDocumentId} Attach Employee Document to Statutory Shared Parental Leave #
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shpp/{ukStatutoryMaternityLeaveDataId}/employeedocument/{employeeDocumentId} Unattach Employee Document from Statutory Shared Parental Leave #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/shppcalc Calculate Statutory Shared Parental Leave Period Data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp Get Statutory Maternity Leave Period Data #
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp Create Statutory Maternity Leave Period data #
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{ukStatutoryMaternityLeaveDataId} Delete Statutory Maternity Leave Data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{ukStatutoryMaternityLeaveDataId} Get Statutory Maternity Leave Period Data By Id #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{ukStatutoryMaternityLeaveDataId} Update Statutory Maternity Leave Period data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{ukStatutoryMaternityLeaveDataId}/attachments Get Statutory Maternity Leave Attachments #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{ukStatutoryMaternityLeaveDataId}/employeedocument/{employeeDocumentId} Attach Employee Document to Statutory Maternity Leave #
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smp/{ukStatutoryMaternityLeaveDataId}/employeedocument/{employeeDocumentId} Unattach Employee Document from Statutory Maternity Leave #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/smpcalc Calculate Statutory Maternity Leave Period Data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp Get Statutory Neonatal Leave Period Data #
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp Create Statutory Neonatal Leave Period data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{ukStatutoryMaternityLeaveDataId} Get Statutory Neonatal Leave Period Data By Id #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{ukStatutoryMaternityLeaveDataId} Update Statutory Neonatal Leave Period data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{ukStatutoryMaternityLeaveDataId}/attachments Get Statutory Neonatal Leave Attachments #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{ukStatutoryMaternityLeaveDataId}/employeedocument/{employeeDocumentId} Attach Employee Document to Statutory Neonatal Leave #
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{ukStatutoryMaternityLeaveDataId}/employeedocument/{employeeDocumentId} Unattach Employee Document from Statutory Neonatal Leave #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncp/{ukStatutoryMaternityLeaveDataId}/paused Pause Statutory Neonatal Care Leave #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sncpcalc Calculate Statutory Neonatal Leave Period Data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp Get Statutory Parental Bereavement Leave Period Data #
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp Create Statutory Parental Bereavement Leave Period data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp/{ukStatutoryParentalBereavementLeaveDataId} Get Statutory Parental Bereavement Leave Period Data By ID #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp/{ukStatutoryParentalBereavementLeaveDataId} Update Statutory Parental Bereavement Leave data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp/{ukStatutoryParentalBereavementLeaveDataId}/attachments Get Statutory Parental Bereavement Leave Attachments #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp/{ukStatutoryParentalBereavementLeaveDataId}/employeedocument/{employeeDocumentId} Attach Employee Document to Statutory Parental Bereavement Leave #
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbp/{ukStatutoryParentalBereavementLeaveDataId}/employeedocument/{employeeDocumentId} Unattach Employee Document from Statutory Parental Bereavement Leave #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spbpcalc Calculate Statutory Parental Bereavement Leave Period Data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp Get Statutory Paternity Leave Period Data #
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp Create Statutory Paternity Leave Period data #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp/{ukStatutoryPaternityLeaveDataId} Get Statutory Paternity Leave Period Data By Id #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp/{ukStatutoryPaternityLeaveDataId}/attachments Get Statutory Paternity Leave Attachments #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp/{ukStatutoryPaternityLeaveDataId}/employeedocument/{employeeDocumentId} Attach Employee Document to Statutory Paternity Leave #
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/spp/{ukStatutoryPaternityLeaveDataId}/employeedocument/{employeeDocumentId} Unattach Employee Document from Statutory Paternity Leave #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/sppcalc Calculate Statutory Paternity Leave Period Data #
POST /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp Create Statutory Sick Pay #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp Get Statutory Sick Pay By Employee #
PUT /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp/{periodOfLeaveId} Update Statutory Sick Pay #
GET /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp/{periodOfLeaveId} Get Statutory Sick Pay By Id #
DELETE /api/v2/business/{businessId}/employee/{employeeId}/statutoryleave/ssp/{periodOfLeaveId} Delete Period of Leave #
GET /api/v2/business/{businessId}/employee/{employeeId}/yeartodate Get Year to date #

Documentation

📖
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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-employee-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/employment-hero:employment-hero-employee-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

employment-hero-employee-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Employment Hero Employee API
  version: '1.0'
  description: 'Operations tagged Employee across 5 of this provider''s published API definitions: employment-hero-payroll-au-swagger.json, employment-hero-payroll-my-swagger.json, employment-hero-payroll-nz-swagger.json, employment-hero-payroll-sg-swagger.json, employment-hero-payroll-uk-swagger.json. Each path carries the servers of the definition it was published in.'
security:
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
- basic: []
- apiKey: []
- oauth2:
  - read
  - write
tags:


# --- truncated at 32 KB (409 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-employee-api-openapi.yml