Employment Hero Employee Qualifications API

Employee Qualifications

Documentation GitHub OpenAPI

Operations 9

GET /api/v2/business/{businessId}/employee/{employeeId}/qualification Get Qualifications for Employee #

POST /api/v2/business/{businessId}/employee/{employeeId}/qualification Add/Update Employee Qualification #

DELETE /api/v2/business/{businessId}/employee/{employeeId}/qualification Delete Employee Qualification #

GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{id} Get Qualification Details #

GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document List Documents for Employee Qualification #

POST /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document Create Employee Qualification Document #

GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{employeeDocumentId} Get Qualification Document by ID #

DELETE /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{employeeDocumentId} Delete Employee Qualification Document #

GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{employeeDocumentId}/content Get Qualification Document File #

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-employeequalifications-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-employeequalifications-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

openapi: 3.2.0
info:
  title: Employment Hero Employee Qualifications API
  version: '1.0'
  description: 'Operations tagged EmployeeQualifications 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:
- name: EmployeeQualifications
  description: Employee Qualifications
paths:
  /api/v2/business/{businessId}/employee/{employeeId}/qualification:
    get:
      tags:
      - EmployeeQualifications
      summary: Get Qualifications for Employee
      description: Retrieves the qualification details for a single employee.
      operationId: EmployeeQualification_GetQualifications
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: IQueryable<EmployeeQualificationModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationModel'
            application/xml:
              schema:
                title: IQueryable<EmployeeQualificationModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationModel'
            text/plain:
              schema:
                title: IQueryable<EmployeeQualificationModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationModel'
            application/octet-stream:
              schema:
                title: IQueryable<EmployeeQualificationModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationModel'
            text/json:
              schema:
                title: IQueryable<EmployeeQualificationModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationModel'
    post:
      tags:
      - EmployeeQualifications
      summary: Add/Update Employee Qualification
      description: Adds or updates a qualification for an employee.
      operationId: EmployeeQualification_Post
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
            text/json:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmployeeQualificationRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/EmployeeQualificationRequest'
          text/plain:
            schema:
              $ref: '#/components/schemas/EmployeeQualificationRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/EmployeeQualificationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/EmployeeQualificationRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/EmployeeQualificationRequest'
    delete:
      tags:
      - EmployeeQualifications
      summary: Delete Employee Qualification
      description: Deletes an employee qualification. Denotes that the employee is no longer qualified for the specified qualification.
      operationId: EmployeeQualification_Delete_2
      parameters:
      - in: query
        name: id
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '200':
          description: OK
  /api/v2/business/{businessId}/employee/{employeeId}/qualification/{id}:
    get:
      tags:
      - EmployeeQualifications
      summary: Get Qualification Details
      description: Gets the details for the qualification with a specific ID.
      operationId: EmployeeQualification_Get_3
      parameters:
      - in: path
        name: id
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
            text/json:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationModel'
  /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document:
    get:
      tags:
      - EmployeeQualifications
      summary: List Documents for Employee Qualification
      description: Lists all the documents associated with a specific employee qualification.
      operationId: EmployeeQualificationDocument_Get
      parameters:
      - in: path
        name: qualificationId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
            application/xml:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
            text/plain:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
            application/octet-stream:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
            text/json:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
    post:
      tags:
      - EmployeeQualifications
      summary: Create Employee Qualification Document
      description: 'Uploads an employee qualification document. Note: the request should be a MIME multipart file upload request.'
      operationId: EmployeeQualificationDocument_Post_2
      parameters:
      - in: path
        name: qualificationId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: query
        name: visible
        title: Boolean
        schema:
          type: boolean
          default: false
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
                x-title: List<EmployeeQualificationDocumentModel>
            application/xml:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
                x-title: List<EmployeeQualificationDocumentModel>
            text/plain:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
                x-title: List<EmployeeQualificationDocumentModel>
            application/octet-stream:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
                x-title: List<EmployeeQualificationDocumentModel>
            text/json:
              schema:
                title: List<EmployeeQualificationDocumentModel>
                type: array
                items:
                  $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
                x-title: List<EmployeeQualificationDocumentModel>
  /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{employeeDocumentId}:
    get:
      tags:
      - EmployeeQualifications
      summary: Get Qualification Document by ID
      description: Gets the details for a qualification document by ID.
      operationId: EmployeeQualificationDocument_Get_3
      parameters:
      - in: path
        name: qualificationId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: employeeDocumentId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
            text/json:
              schema:
                $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
    delete:
      tags:
      - EmployeeQualifications
      summary: Delete Employee Qualification Document
      description: Deletes a specific employee qualification document.
      operationId: EmployeeQualificationDocument_Delete_4
      parameters:
      - in: path
        name: qualificationId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: employeeDocumentId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '200':
          description: OK
  /api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{employeeDocumentId}/content:
    get:
      tags:
      - EmployeeQualifications
      summary: Get Qualification Document File
      description: Gets the file for an employee qualification document by ID.
      operationId: EmployeeQualificationDocument_Content
      parameters:
      - in: path
        name: qualificationId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: employeeDocumentId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      - in: path
        name: employeeId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentFile'
            application/xml:
              schema:
                $ref: '#/components/schemas/DocumentFile'
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentFile'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/DocumentFile'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentFile'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    DocumentFile:
      title: DocumentFile
      type: object
      properties:
        contentLength:
          format: int64
          title: Int64
          type: integer
          x-title: Int64
        contentType:
          title: String
          type: string
          x-title: String
        bytes:
          format: byte
          title: Byte[]
          type: string
          x-title: Byte[]
        filename:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    EmployeeQualificationModel:
      title: EmployeeQualificationModel
      type: object
      properties:
        qualificationId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        expiryDate:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        issueDate:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        documents:
          title: IList<EmployeeQualificationDocumentModel>
          type: array
          items:
            $ref: '#/components/schemas/EmployeeQualificationDocumentModel'
        referenceNumber:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    EmployeeQualificationDocumentModel:
      title: EmployeeQualificationDocumentModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        dateCreated:
          format: date-time
          title: DateTime
          type: string
          x-title: DateTime
        visible:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    EmployeeQualificationRequest:
      title: EmployeeQualificationRequest
      type: object
      properties:
        qualificationId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        expiryDate:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        issueDate:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        referenceNumber:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    ProblemDetails:
      title: ProblemDetails
      type: object
      properties:
        type:
          title: String
          type: string
          x-title: String
        title:
          title: String
          type: string
          x-title: String
        status:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        detail:
          title: String
          type: string
          x-title: String
        instance:
          title: String
          type: string
          x-title: String
      additionalProperties:
        title: Object
        x-title: Object
        type: object
  securitySchemes:
    basic:
      type: http
      scheme: basic
      description: Your API key should be the username and the password can be left blank
    apiKey:
      type: apiKey
      in: header
      description: API Key Authentication
    oauth2:
      type: oauth2
      flows:
        implicit:
          scopes:
            read: Read access to protected resources
            write: Write access to protected resources
          authorizationUrl: https://keypay.yourpayroll.com.au/oauth/authorise
      description: OAuth2 Implicit Grant
x-refined-from:
- 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