Employment Hero

Employment Hero User API

User

GitHub OpenAPI

Operations 3

GET /api/v2/user Get User Details #
POST /api/v2/user Create New User #
PUT /api/v2/user Update User #

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-user-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-user-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-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Employment Hero User API
  version: '1.0'
  description: 'Operations tagged User 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: User
  description: User
paths:
  /api/v2/user:
    get:
      tags:
      - User
      summary: Get User Details
      description: Gets details about the user.
      operationId: User_Get
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/UserModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/UserModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/UserModel'
            text/json:
              schema:
                $ref: '#/components/schemas/UserModel'
    post:
      tags:
      - User
      summary: Create New User
      description: 'Creates a new user and sends an email to inform the user.


        In order to make sure that the correct brand details are included in the email, be sure to `POST` the API request to `https://{yourbrand}.yourpayroll.com.au`.


        To prevent sending of the new user email, set `apiOnly` to `true` in the request.'
      operationId: User_Post_2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewUserCreatedModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/NewUserCreatedModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/NewUserCreatedModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/NewUserCreatedModel'
            text/json:
              schema:
                $ref: '#/components/schemas/NewUserCreatedModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewUserModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/NewUserModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/NewUserModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/NewUserModel'
          text/json:
            schema:
              $ref: '#/components/schemas/NewUserModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/NewUserModel'
    put:
      tags:
      - User
      summary: Update User
      description: 'This is currently restricted to updating the user''s "email confirmation" status only.

        The API user (brand manager or reseller) must have brand exclusive access to the user

        i.e. the user must only have access to businesses/employees that the API user manages.'
      operationId: User_Put_3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserUpdatedModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/UserUpdatedModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/UserUpdatedModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/UserUpdatedModel'
            text/json:
              schema:
                $ref: '#/components/schemas/UserUpdatedModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/UpdateUserModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/UpdateUserModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/UpdateUserModel'
          text/json:
            schema:
              $ref: '#/components/schemas/UpdateUserModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UpdateUserModel'
components:
  schemas:
    NewUserCreatedModel:
      title: NewUserCreatedModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        username:
          title: String
          type: string
          x-title: String
        displayName:
          title: String
          type: string
          x-title: String
        timeZone:
          title: String
          type: string
          x-title: String
        apiKey:
          title: String
          type: string
          x-title: String
        email:
          title: String
          type: string
          x-title: String
        emailConfirmed:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    UserUpdatedModel:
      title: UserUpdatedModel
      type: object
      properties:
        username:
          title: String
          type: string
          x-title: String
        emailConfirmed:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    UpdateUserModel:
      title: UpdateUserModel
      required:
      - username
      type: object
      properties:
        username:
          title: String
          minLength: 1
          type: string
          x-title: String
        emailConfirmed:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    NewUserModel:
      title: NewUserModel
      required:
      - displayName
      - username
      type: object
      properties:
        username:
          title: String
          minLength: 1
          type: string
          x-title: String
        displayName:
          title: String
          minLength: 1
          type: string
          x-title: String
        timeZone:
          title: String
          type: string
          x-title: String
        apiOnly:
          title: Boolean
          type: boolean
          x-title: Boolean
        email:
          title: String
          type: string
          x-title: String
        emailConfirmed:
          title: Boolean
          type: boolean
          x-title: Boolean
      additionalProperties: false
    UserModel:
      title: UserModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        email:
          title: String
          type: string
          x-title: String
        displayName:
          title: String
          type: string
          x-title: String
        timeZone:
          title: String
          type: string
          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-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