Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Employment Hero Documents API

The Documents API from Employment Hero — 1 operation(s) for documents.

Employment Hero Documents API is one of 12 APIs that Employment Hero publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 1 path. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.employmenthero.com.

2 operations 1 paths 0 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.employmenthero.com/api/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Employment Hero Documents API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 2
GET
/api/v1/organisations/{organisation_id}/employees/{employee_id}/documents
List employee documents
listEmployeeDocuments 2 params → 200
POST
/api/v1/organisations/{organisation_id}/employees/{employee_id}/documents
Upload employee document
uploadEmployeeDocument 2 params body → 201

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

employment-hero-documents-api-openapi.yml Raw ↑

Other APIs Employment Hero publishes across the network.

Employment Hero REST API
Employment Hero Payroll API (KeyPay)
Employment Hero Bank Accounts API
Employment Hero Certifications API
Employment Hero Cost Centres API
Employment Hero Custom Fields API
Employment Hero Departments API
Employment Hero Emergency Contacts API
Employment Hero Employees API
Employment Hero Forms API
Employment Hero Job Histories API