Employment Hero

Employment Hero Employee Groups API

Employee Groups

GitHub OpenAPI

Operations 5

GET /api/v2/business/{businessId}/employeegroup List Employee Groups #
POST /api/v2/business/{businessId}/employeegroup Create Employee Group #
GET /api/v2/business/{businessId}/employeegroup/{id} Get Employee Group by ID #
PUT /api/v2/business/{businessId}/employeegroup/{id} Update Employee Group #
DELETE /api/v2/business/{businessId}/employeegroup/{id} Delete Employee Group #

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-employeegroups-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-employeegroups-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-employeegroups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Employment Hero Employee Groups API
  version: '1.0'
  description: 'Operations tagged EmployeeGroups 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: EmployeeGroups
  description: Employee Groups
paths:
  /api/v2/business/{businessId}/employeegroup:
    get:
      tags:
      - EmployeeGroups
      summary: List Employee Groups
      description: 'Lists all the employee groups for the business.


        This operation supports OData queries.'
      operationId: AuEmployeeGroup_GetGroups
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: IQueryable<AuEmployeeGroupModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuEmployeeGroupModel'
            application/xml:
              schema:
                title: IQueryable<AuEmployeeGroupModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuEmployeeGroupModel'
            text/plain:
              schema:
                title: IQueryable<AuEmployeeGroupModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuEmployeeGroupModel'
            application/octet-stream:
              schema:
                title: IQueryable<AuEmployeeGroupModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuEmployeeGroupModel'
            text/json:
              schema:
                title: IQueryable<AuEmployeeGroupModel>
                type: array
                items:
                  $ref: '#/components/schemas/AuEmployeeGroupModel'
    post:
      tags:
      - EmployeeGroups
      summary: Create Employee Group
      description: Creates a new employee group for the business.
      operationId: AuEmployeeGroup_Post
      parameters:
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuEmployeeGroupModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/AuEmployeeGroupModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/AuEmployeeGroupModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AuEmployeeGroupModel'
            text/json:
              schema:
                $ref: '#/components/schemas/AuEmployeeGroupModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          text/json:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
  /api/v2/business/{businessId}/employeegroup/{id}:
    get:
      tags:
      - EmployeeGroups
      summary: Get Employee Group by ID
      description: Gets the employee group with the specified ID.
      operationId: AuEmployeeGroup_Get_2
      parameters:
      - in: path
        name: id
        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/AuDetailedEmployeeGroupModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/AuDetailedEmployeeGroupModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/AuDetailedEmployeeGroupModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AuDetailedEmployeeGroupModel'
            text/json:
              schema:
                $ref: '#/components/schemas/AuDetailedEmployeeGroupModel'
    put:
      tags:
      - EmployeeGroups
      summary: Update Employee Group
      description: Updates the specified employee group.
      operationId: AuEmployeeGroup_Put_3
      parameters:
      - in: path
        name: id
        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/AuEmployeeGroupModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/AuEmployeeGroupModel'
            text/plain:
              schema:
                $ref: '#/components/schemas/AuEmployeeGroupModel'
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/AuEmployeeGroupModel'
            text/json:
              schema:
                $ref: '#/components/schemas/AuEmployeeGroupModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          text/plain:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          text/json:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AuEmployeeGroupModel'
    delete:
      tags:
      - EmployeeGroups
      summary: Delete Employee Group
      description: Deletes the employee group with the specified ID.
      operationId: AuEmployeeGroup_Delete_4
      parameters:
      - in: path
        name: id
        required: true
        title: Int32
        schema:
          type: integer
          format: int32
      - in: path
        name: businessId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
components:
  schemas:
    AuEmployeeFilterModel:
      title: AuEmployeeFilterModel
      type: object
      properties:
        filterType:
          title: AuFilterTypeEnum
          enum:
          - Location
          - LocationOrParents
          - Employee
          - PaySchedule
          - EmploymentType
          - EmployingEntity
          - Tag
          type: string
        operator:
          title: FilterOperatorEnum
          enum:
          - In
          - NotIn
          type: string
        value:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    AuEmployeeGroupModel:
      title: AuEmployeeGroupModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
          x-title: FilterCombinationStrategyEnum
        filters:
          title: IList<AuEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/AuEmployeeFilterModel'
          x-title: IList<AuEmployeeFilterModel>
      additionalProperties: false
    AuDetailedEmployeeGroupModel:
      title: AuDetailedEmployeeGroupModel
      type: object
      properties:
        matchingEmployees:
          title: IList<MatchingEmployeeModel>
          type: array
          items:
            $ref: '#/components/schemas/MatchingEmployeeModel'
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
        filters:
          title: IList<AuEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/AuEmployeeFilterModel'
      additionalProperties: false
    MatchingEmployeeModel:
      title: MatchingEmployeeModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        externalId:
          title: String
          type: string
          x-title: String
        name:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    MyEmployeeFilterModel:
      title: MyEmployeeFilterModel
      type: object
      properties:
        filterType:
          title: MyFilterTypeEnum
          enum:
          - Location
          - LocationOrParents
          - Employee
          - PaySchedule
          - EmploymentType
          - Tag
          type: string
        operator:
          title: FilterOperatorEnum
          enum:
          - In
          - NotIn
          type: string
        value:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    MyEmployeeGroupModel:
      title: MyEmployeeGroupModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
          x-title: FilterCombinationStrategyEnum
        filters:
          title: IList<MyEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/MyEmployeeFilterModel'
          x-title: IList<MyEmployeeFilterModel>
      additionalProperties: false
    MyDetailedEmployeeGroupModel:
      title: MyDetailedEmployeeGroupModel
      type: object
      properties:
        matchingEmployees:
          title: IList<MatchingEmployeeModel>
          type: array
          items:
            $ref: '#/components/schemas/MatchingEmployeeModel'
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
        filters:
          title: IList<MyEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/MyEmployeeFilterModel'
      additionalProperties: false
    NzDetailedEmployeeGroupModel:
      title: NzDetailedEmployeeGroupModel
      type: object
      properties:
        matchingEmployees:
          title: IList<MatchingEmployeeModel>
          type: array
          items:
            $ref: '#/components/schemas/MatchingEmployeeModel'
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
        filters:
          title: IList<NzEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/NzEmployeeFilterModel'
      additionalProperties: false
    NzEmployeeFilterModel:
      title: NzEmployeeFilterModel
      type: object
      properties:
        filterType:
          title: NzFilterTypeEnum
          enum:
          - Location
          - LocationOrParents
          - Employee
          - PaySchedule
          - EmploymentType
          - Tag
          type: string
        operator:
          title: FilterOperatorEnum
          enum:
          - In
          - NotIn
          type: string
        value:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    NzEmployeeGroupModel:
      title: NzEmployeeGroupModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
          x-title: FilterCombinationStrategyEnum
        filters:
          title: IList<NzEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/NzEmployeeFilterModel'
          x-title: IList<NzEmployeeFilterModel>
      additionalProperties: false
    SgDetailedEmployeeGroupModel:
      title: SgDetailedEmployeeGroupModel
      type: object
      properties:
        matchingEmployees:
          title: IList<MatchingEmployeeModel>
          type: array
          items:
            $ref: '#/components/schemas/MatchingEmployeeModel'
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
        filters:
          title: IList<SgEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/SgEmployeeFilterModel'
      additionalProperties: false
    SgEmployeeGroupModel:
      title: SgEmployeeGroupModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
          x-title: FilterCombinationStrategyEnum
        filters:
          title: IList<SgEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/SgEmployeeFilterModel'
          x-title: IList<SgEmployeeFilterModel>
      additionalProperties: false
    SgEmployeeFilterModel:
      title: SgEmployeeFilterModel
      type: object
      properties:
        filterType:
          title: SgFilterTypeEnum
          enum:
          - Location
          - LocationOrParents
          - Employee
          - PaySchedule
          - EmploymentType
          - Tag
          type: string
        operator:
          title: FilterOperatorEnum
          enum:
          - In
          - NotIn
          type: string
        value:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    UkEmployeeGroupModel:
      title: UkEmployeeGroupModel
      type: object
      properties:
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
          x-title: FilterCombinationStrategyEnum
        filters:
          title: IList<UkEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/UkEmployeeFilterModel'
          x-title: IList<UkEmployeeFilterModel>
      additionalProperties: false
    UkEmployeeFilterModel:
      title: UkEmployeeFilterModel
      type: object
      properties:
        filterType:
          title: UkFilterTypeEnum
          enum:
          - Location
          - LocationOrParents
          - Employee
          - PaySchedule
          - Tag
          type: string
        operator:
          title: FilterOperatorEnum
          enum:
          - In
          - NotIn
          type: string
        value:
          title: String
          type: string
          x-title: String
      additionalProperties: false
    UkDetailedEmployeeGroupModel:
      title: UkDetailedEmployeeGroupModel
      type: object
      properties:
        matchingEmployees:
          title: IList<MatchingEmployeeModel>
          type: array
          items:
            $ref: '#/components/schemas/MatchingEmployeeModel'
        id:
          format: int32
          title: Int32
          type: integer
          x-title: Int32
        name:
          title: String
          type: string
          x-title: String
        filterCombinationStrategy:
          title: FilterCombinationStrategyEnum
          enum:
          - Or
          - And
          type: string
        filters:
          title: IList<UkEmployeeFilterModel>
          type: array
          items:
            $ref: '#/components/schemas/UkEmployeeFilterModel'
      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