Employment Hero Custom Fields API

The Custom Fields API from Employment Hero — 1 operation(s) for custom fields.

Documentation GitHub OpenAPI

Specifications

https://raw.githubusercontent.com/api-evangelist/employment-hero/refs/heads/main/openapi/employment-hero-custom-fields-api-openapi.yml

OpenAPI Specification

openapi: 3.1.0
info:
  title: Employment Hero REST Bank Accounts Custom Fields 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: Custom Fields
paths:
  /api/v1/organisations/{organisation_id}/custom_fields:
    get:
      summary: List custom fields
      operationId: listCustomFields
      tags:
      - Custom Fields
      parameters:
      - $ref: '#/components/parameters/OrganisationId'
      responses:
        '200':
          description: Custom fields
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: {}