Employment Hero

Employment Hero White Label API

White Label

GitHub OpenAPI

Operations 4

GET /api/v2/whitelabel List White Labels #
GET /api/v2/whitelabel/{id} Get White Label by ID #
GET /api/v2/whitelabel/{whiteLabelId}/reports/activeemployees Active Employees Report #
GET /api/v2/whitelabel/{whitelabelId}/reports/signups Signup Report #

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-whitelabel-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-whitelabel-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-whitelabel-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Employment Hero White Label API
  version: '1.0'
  description: 'Operations tagged WhiteLabel 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: WhiteLabel
  description: White Label
paths:
  /api/v2/whitelabel:
    get:
      tags:
      - WhiteLabel
      summary: List White Labels
      description: Lists all the white labels to which you have access.
      operationId: WhiteLabel_GetWhiteLabels
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: IEnumerable<WhiteLabelModel>
                type: array
                items:
                  $ref: '#/components/schemas/WhiteLabelModel'
            application/xml:
              schema:
                title: IEnumerable<WhiteLabelModel>
                type: array
                items:
                  $ref: '#/components/schemas/WhiteLabelModel'
            text/plain:
              schema:
                title: IEnumerable<WhiteLabelModel>
                type: array
                items:
                  $ref: '#/components/schemas/WhiteLabelModel'
            application/octet-stream:
              schema:
                title: IEnumerable<WhiteLabelModel>
                type: array
                items:
                  $ref: '#/components/schemas/WhiteLabelModel'
            text/json:
              schema:
                title: IEnumerable<WhiteLabelModel>
                type: array
                items:
                  $ref: '#/components/schemas/WhiteLabelModel'
  /api/v2/whitelabel/{id}:
    get:
      tags:
      - WhiteLabel
      summary: Get White Label by ID
      description: Gets the white label with the specified ID.
      operationId: WhiteLabel_Get
      parameters:
      - in: path
        name: id
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhiteLabelModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/WhiteLabelModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/WhiteLabelModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/WhiteLabelModel'
            text/json:
              schema:
                $ref: '#/components/schemas/WhiteLabelModel'
  /api/v2/whitelabel/{whiteLabelId}/reports/activeemployees:
    get:
      tags:
      - WhiteLabel
      summary: Active Employees Report
      description: White Label Active Employees Report
      operationId: AuWhiteLabelActiveEmployeeReport_Get
      parameters:
      - in: path
        name: whiteLabelId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: query
        name: EmailAddresses
        title: String
        schema:
          type: string
      - in: query
        name: IncludeInactiveBusinesses
        title: Boolean
        schema:
          type: boolean
      - in: query
        name: FromDate
        title: DateTime
        schema:
          type: string
          format: date-time
      - in: query
        name: ToDate
        title: DateTime
        schema:
          type: string
          format: date-time
      - in: query
        name: LocationId
        title: Int32
        schema:
          type: integer
          format: int32
      - in: query
        name: EmployingEntityId
        title: Nullable<Int32>
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: IList<AuActiveEmployeesModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuActiveEmployeesModel'
                x-title: IList<AuActiveEmployeesModel>
            application/xml:
              schema:
                title: IList<AuActiveEmployeesModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuActiveEmployeesModel'
                x-title: IList<AuActiveEmployeesModel>
            text/plain:
              schema:
                title: IList<AuActiveEmployeesModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuActiveEmployeesModel'
                x-title: IList<AuActiveEmployeesModel>
            application/octet-stream:
              schema:
                title: IList<AuActiveEmployeesModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuActiveEmployeesModel'
                x-title: IList<AuActiveEmployeesModel>
            text/json:
              schema:
                title: IList<AuActiveEmployeesModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuActiveEmployeesModel'
                x-title: IList<AuActiveEmployeesModel>
  /api/v2/whitelabel/{whitelabelId}/reports/signups:
    get:
      tags:
      - WhiteLabel
      summary: Signup Report
      description: White Label sign up report
      operationId: WhiteLabelReport_Get
      parameters:
      - in: path
        name: whitelabelId
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: query
        name: EmailAddresses
        title: String
        schema:
          type: string
      - in: query
        name: FromDate
        title: DateTime
        schema:
          type: string
          format: date-time
      - in: query
        name: ToDate
        title: DateTime
        schema:
          type: string
          format: date-time
      - in: query
        name: LocationId
        title: Int32
        schema:
          type: integer
          format: int32
      - in: query
        name: EmployingEntityId
        title: Nullable<Int32>
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: IList<SignupModel>
                type: array
                items:
                  $ref: '#/components/schemas/SignupModel'
                x-title: IList<SignupModel>
            application/xml:
              schema:
                title: IList<SignupModel>
                type: array
                items:
                  $ref: '#/components/schemas/SignupModel'
                x-title: IList<SignupModel>
            text/plain:
              schema:
                title: IList<SignupModel>
                type: array
                items:
                  $ref: '#/components/schemas/SignupModel'
                x-title: IList<SignupModel>
            application/octet-stream:
              schema:
                title: IList<SignupModel>
                type: array
                items:
                  $ref: '#/components/schemas/SignupModel'
                x-title: IList<SignupModel>
            text/json:
              schema:
                title: IList<SignupModel>
                type: array
                items:
                  $ref: '#/components/schemas/SignupModel'
                x-title: IList<SignupModel>
components:
  schemas:
    SignupModel:
      title: SignupModel
      type: object
      properties:
        businessId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        businessName:
          title: String
          type: string
          x-title: String
        dateCreated:
          format: date-time
          title: DateTime
          type: string
          x-title: DateTime
        billingPlan:
          title: String
          type: string
          x-title: String
        realmId:
          title: String
          type: string
          x-title: String
        externalId:
          title: String
          type: string
          x-title: String
        contactEmail:
          title: String
          type: string
          x-title: String
        emailAddresses:
          title: String
          type: string
          x-title: String
        userIds:
          title: String
          type: string
          x-title: String
        numberOfCompleteEmployees:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        numberOfIncompleteEmployees:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        dateLastPayRunFinalised:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
      additionalProperties: false
    AuActiveEmployeesModel:
      title: AuActiveEmployeesModel
      type: object
      properties:
        abn:
          title: String
          type: string
          x-title: String
        isStpEnabled:
          title: Boolean
          type: boolean
          x-title: Boolean
        businessId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        businessName:
          title: String
          type: string
          x-title: String
        dateCreated:
          format: date-time
          title: DateTime
          type: string
          x-title: DateTime
        billingPlan:
          title: String
          type: string
          x-title: String
        realmId:
          title: String
          type: string
          x-title: String
        externalId:
          title: String
          type: string
          x-title: String
        emailAddresses:
          title: String
          type: string
          x-title: String
        userIds:
          title: String
          type: string
          x-title: String
        numberOfIncompleteEmployees:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        numberOfCompleteEmployees:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        numberOfEmployeesPaid:
          format: int32
          title: Int32
          type: integer
          readOnly: true
          x-title: Int32
        numberOfPayRuns:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        dateLastPayRunFinalised:
          format: date-time
          title: Nullable<DateTime>
          type: string
          readOnly: true
          x-title: Nullable<DateTime>
        dateLastBillableActivity:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        activeEmps:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
      additionalProperties: false
    WhiteLabelModel:
      title: WhiteLabelModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    CommonActiveEmployeesModel:
      title: CommonActiveEmployeesModel
      type: object
      properties:
        businessId:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        businessName:
          title: String
          type: string
          x-title: String
        dateCreated:
          format: date-time
          title: DateTime
          type: string
          x-title: DateTime
        billingPlan:
          title: String
          type: string
          x-title: String
        realmId:
          title: String
          type: string
          x-title: String
        externalId:
          title: String
          type: string
          x-title: String
        emailAddresses:
          title: String
          type: string
          x-title: String
        userIds:
          title: String
          type: string
          x-title: String
        numberOfIncompleteEmployees:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        numberOfCompleteEmployees:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        numberOfEmployeesPaid:
          format: int32
          title: Int32
          type: integer
          readOnly: true
          x-title: Int32
        numberOfPayRuns:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        dateLastPayRunFinalised:
          format: date-time
          title: Nullable<DateTime>
          type: string
          readOnly: true
          x-title: Nullable<DateTime>
        dateLastBillableActivity:
          format: date-time
          title: Nullable<DateTime>
          type: string
          x-title: Nullable<DateTime>
        activeEmps:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
      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-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