Employment Hero

Employment Hero Award API

Award

GitHub OpenAPI

Operations 3

GET /api/v2/business/{businessId}/award List Awards #
GET /api/v2/business/{businessId}/award/installed List Installed Awards #
PUT /api/v2/business/{businessId}/award/{awardId}/install Install Award #

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-award-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-award-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-award-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Australia Award API
  version: AU
  description: Award
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: Award
  description: Award
paths:
  /api/v2/business/{businessId}/award:
    get:
      tags:
      - Award
      summary: List Awards
      description: 'Returns all awards available to the business with their current status.

        Use the optional status filter to narrow results (e.g. OutOfDate).'
      operationId: AuAward_GetAwards
      parameters:
      - in: query
        name: status
        title: Nullable<AwardImportStatus>
        schema:
          type: string
          enum:
          - NotImported
          - UpToDate
          - OutOfDate
          - NotAvailable
          - QueuedForInstall
          - Installing
          - InstallationFailed
          - UpdateFailed
          - Updating
          - QueuedForUpdate
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: IList<AwardStatusModel>
                type: array
                items:
                  $ref: '#/components/schemas/AwardStatusModel'
            application/xml:
              schema:
                title: IList<AwardStatusModel>
                type: array
                items:
                  $ref: '#/components/schemas/AwardStatusModel'
            text/plain:
              schema:
                title: IList<AwardStatusModel>
                type: array
                items:
                  $ref: '#/components/schemas/AwardStatusModel'
            application/octet-stream:
              schema:
                title: IList<AwardStatusModel>
                type: array
                items:
                  $ref: '#/components/schemas/AwardStatusModel'
            text/json:
              schema:
                title: IList<AwardStatusModel>
                type: array
                items:
                  $ref: '#/components/schemas/AwardStatusModel'
  /api/v2/business/{businessId}/award/installed:
    get:
      tags:
      - Award
      summary: List Installed Awards
      description: Returns the awards currently installed on the business.
      operationId: AuAward_GetInstalledAwards
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: IList<InstalledAwardModel>
                type: array
                items:
                  $ref: '#/components/schemas/InstalledAwardModel'
            application/xml:
              schema:
                title: IList<InstalledAwardModel>
                type: array
                items:
                  $ref: '#/components/schemas/InstalledAwardModel'
            text/plain:
              schema:
                title: IList<InstalledAwardModel>
                type: array
                items:
                  $ref: '#/components/schemas/InstalledAwardModel'
            application/octet-stream:
              schema:
                title: IList<InstalledAwardModel>
                type: array
                items:
                  $ref: '#/components/schemas/InstalledAwardModel'
            text/json:
              schema:
                title: IList<InstalledAwardModel>
                type: array
                items:
                  $ref: '#/components/schemas/InstalledAwardModel'
  /api/v2/business/{businessId}/award/{awardId}/install:
    put:
      tags:
      - Award
      summary: Install Award
      description: Installs an award for the specified business. This operation is asynchronous and returns a job ID that can be used to track the installation progress.
      operationId: AuAward_InstallAward
      parameters:
      - in: path
        name: awardId
        description: The ID of the award to install
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwardInstallResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/AwardInstallResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/AwardInstallResponse'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AwardInstallResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AwardInstallResponse'
        '400':
          description: Bad Request
          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'
        '500':
          description: Internal Server Error
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwardInstallRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/AwardInstallRequest'
          text/plain:
            schema:
              $ref: '#/components/schemas/AwardInstallRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AwardInstallRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AwardInstallRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AwardInstallRequest'
        description: Installation configuration options
components:
  schemas:
    AwardStatusModel:
      title: AwardStatusModel
      required:
      - name
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        awardId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        status:
          title: AwardImportStatus
          enum:
          - NotImported
          - UpToDate
          - OutOfDate
          - NotAvailable
          - QueuedForInstall
          - Installing
          - InstallationFailed
          - UpdateFailed
          - Updating
          - QueuedForUpdate
          type: string
        latestVersionDate:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
      additionalProperties: false
    AwardInstallResponse:
      title: AwardInstallResponse
      type: object
      properties:
        jobId:
          format: uuid
          title: Nullable<Guid>
          type: string
        employeesWithOverriddenRate:
          title: IList<EmployeeDto>
          type: array
          items:
            $ref: '#/components/schemas/EmployeeDto'
      additionalProperties: false
    AwardInstallRequest:
      title: AwardInstallRequest
      type: object
      properties:
        awardPackageVersionId:
          format: int32
          title: Nullable<Int32>
          type: integer
          x-title: Nullable<Int32>
        updateRuleSets:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        updatePayRates:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        reApplyLeaveAllowanceTemplates:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        preserveCustomRules:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        preserveDisabledRules:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        preserveCustomPayCategories:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        preserveCustomRuleSetPeriod:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        preserveCustomWorkTypes:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        preserveCustomLeaveAllowanceTemplates:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        preserveAutoProgressionSettings:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        preserveCustomPayRateTemplates:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
        preserveCustomEmploymentAgreements:
          title: Nullable<Boolean>
          type: boolean
          x-title: Nullable<Boolean>
      additionalProperties: false
    InstalledAwardModel:
      title: InstalledAwardModel
      required:
      - name
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        awardId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          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
    EmployeeDto:
      title: EmployeeDto
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        firstName:
          title: String
          type: string
          x-title: String
        otherName:
          title: String
          type: string
          x-title: String
        middleName:
          title: String
          type: string
          x-title: String
        surname:
          title: String
          type: string
          x-title: String
        name:
          title: String
          type: string
          readOnly: true
          x-title: String
      additionalProperties: false
  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-navigateMethodsByName: true