Employment Hero Employees API

openapi: 3.1.0
info:
  title: Employment Hero REST Bank Accounts Employees API
  description: 'Employment Hero is an AI-powered Employment Operating System covering HR, payroll, recruitment, onboarding, learning, and employee benefits. This versioned REST API exposes organisations, employees, departments, documents, custom fields, forms, certifications, cost centres, emergency contacts, contractor job histories, and bank account data. Authentication is OAuth 2.0 with short-lived (15-minute) bearer access tokens.

    '
  version: 1.0.0
  contact:
    name: Employment Hero Developer Portal
    url: https://developer.employmenthero.com
servers:
- url: https://api.employmenthero.com
security:
- oauth2: []
tags:
- name: Employees
paths:
  /api/v1/organisations/{organisation_id}/employees:
    get:
      summary: List employees
      operationId: listEmployees
      tags:
      - Employees
      parameters:
      - $ref: '#/components/parameters/OrganisationId'
      responses:
        '200':
          description: Employee list
  /api/v1/organisations/{organisation_id}/employees/{id}:
    get:
      summary: Get employee
      operationId: getEmployee
      tags:
      - Employees
      parameters:
      - $ref: '#/components/parameters/OrganisationId'
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Employee details
  /api/v1/organisations/{organisation_id}/employees/quick_add_employee:
    post:
      summary: Quick add employee
      operationId: quickAddEmployee
      tags:
      - Employees
      parameters:
      - $ref: '#/components/parameters/OrganisationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Employee created
components:
  parameters:
    OrganisationId:
      name: organisation_id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://oauth.employmenthero.com/oauth2/authorize
          tokenUrl: https://oauth.employmenthero.com/oauth2/token
          refreshUrl: https://oauth.employmenthero.com/oauth2/token
          scopes: {}