employmenthero v1.0.0A

Immutable. This exact content never changes and is served at /api/v1/blob/3cd1e8e746759257.

---
name: employmenthero
description: |
  Employment Hero integration via Apideck's HRIS unified API — same methods work across every connector in HRIS, switch by changing `serviceId`. Use when the user wants to read or sync employees, departments, payrolls, and time-off records in Employment Hero. Routes through Apideck with serviceId "employmenthero".
license: Apache-2.0
alwaysApply: false
metadata:
  author: apideck
  version: "1.0.0"
  serviceId: employmenthero
  unifiedApis: ["hris"]
  authType: oauth2
  tier: "2"
  verified: true
  status: beta
  difficulty: moderate
  partnershipRequired: false
  sandboxAvailable: true
---

# Employment Hero (via Apideck)

Access Employment Hero through Apideck's **HRIS** unified API — one of 58 HRIS connectors that share the same method surface. Code you write here ports to BambooHR, Workday, Deel and 54 other HRIS connectors by changing a single `serviceId` string. Apideck handles auth, pagination, rate limiting, and retries so you don't write per-tenant Employment Hero plumbing.

> **Beta connector.** Employment Hero is currently in beta on Apideck. Expect partial resource coverage and occasional mapping gaps. Always verify coverage (see below) and fall back to the Proxy API for unsupported operations.

## Quick facts

- **Apideck serviceId:** `employmenthero`
- **Unified API:** HRIS
- **Auth type:** oauth2
- **Status:** beta
- **Gotchas:** [page](https://developers.apideck.com/apis/hris/employmenthero/gotchas)
- **Employment Hero docs:** https://developer.employmenthero.com
- **Homepage:** https://employmenthero.com

## At a glance

- **Implementation difficulty:** moderate — Platinum-Tier Plan Required for API Access
- **Vendor partnership required:** no ([Employment Hero Partner Program](https://employmenthero.com/partner-network/technology-integration/))
- **Apideck-managed credentials:** available — For testing only: OAuth shows "Apideck" as the requesting application; production integrations use your own Employment Hero OAuth app.
- **Account type required:** Employment Hero HR organisation.
- **Consumer access level:** Admin or owner recommended, so that all API endpoints are accessible.
- **Sandbox:** available ([signup](https://employmenthero.com/free-trial/)) — Free trial organisation with 2 weeks of Developer Portal access; email partner@employmenthero.com to extend it or request a permanent sandbox.
- **Costs:** API access needs a Platinum subscription or above.
- **Rate limits:** 20 requests per second and 100 requests per minute.
- **Authentication:** Authorization Code flow.

> Facts synced from Apideck's connector metadata API — `GET /connector/connectors/employmenthero` (`overview` field) is the live, authoritative version.

## When to use this skill

Activate this skill when the user explicitly wants to work with **Employment Hero** — for example, "sync employees in Employment Hero" or "list time-off requests in Employment Hero". This skill teaches the agent:

1. Which Apideck unified API covers Employment Hero (HRIS)
2. The correct `serviceId` to pass on every call (`employmenthero`)
3. Employment Hero-specific auth and coverage caveats

For the full method surface (parameters, pagination, filtering), use your language SDK skill:

- [`apideck-node`](../../skills/apideck-node/), [`apideck-python`](../../skills/apideck-python/), [`apideck-dotnet`](../../skills/apideck-dotnet/), [`apideck-java`](../../skills/apideck-java/), [`apideck-go`](../../skills/apideck-go/), [`apideck-php`](../../skills/apideck-php/), or [`apideck-rest`](../../skills/apideck-rest/)

For the raw OpenAPI spec:

- **HRIS:** [https://specs.apideck.com/hris.yml](https://specs.apideck.com/hris.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=hris)

## Minimal example (TypeScript)

```typescript
import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: process.env.APIDECK_APP_ID,
  consumerId: "your-consumer-id",
});

// List employees in Employment Hero
const { data } = await apideck.hris.employees.list({
  serviceId: "employmenthero",
});
```

## Portable across 58 HRIS connectors

The Apideck **HRIS** unified API exposes the same methods for every connector in its catalog. Switching from Employment Hero to another HRIS connector is a one-string change — no rewrite, no new SDK.

```typescript
// Today — Employment Hero
await apideck.hris.employees.list({ serviceId: "employmenthero" });

// Tomorrow — same code, different connector
await apideck.hris.employees.list({ serviceId: "bamboohr" });
await apideck.hris.employees.list({ serviceId: "workday" });
```

This is the compounding advantage of using Apideck over integrating Employment Hero directly: code against the unified HRIS API once, gain access to every connector in it. New connectors Apideck adds become available to your app without code changes.

## Authentication

- **Type:** OAuth 2.0
- **Managed by:** Apideck Vault — Apideck handles the full OAuth dance (authorization code flow, token exchange, refresh). Never ask the user for API keys or tokens directly.
- **User setup:** Users authorize via the Vault modal. Connection state progresses `available → added → authorized → callable`.
- **Token refresh:** automatic. Expired tokens are refreshed transparently on the next API call.

See [`apideck-best-practices`](../../skills/apideck-best-practices/) for Vault setup, connection lifecycle, and handling re-auth flows.

## Verifying coverage

Not every HRIS operation is supported by every connector. Always verify before assuming a method works:

```bash
curl 'https://unify.apideck.com/connector/connectors/employmenthero' \
  -H "Authorization: Bearer ${APIDECK_API_KEY}" \
  -H "x-apideck-app-id: ${APIDECK_APP_ID}"
```

See [`apideck-connector-coverage`](../../skills/apideck-connector-coverage/) for patterns around `UnsupportedOperationError` and connector-specific fallbacks.

## Escape hatch: Proxy API

When an endpoint isn't covered by the HRIS unified API, use Apideck's Proxy to call Employment Hero directly — Apideck injects auth headers and handles token refresh. Set `x-apideck-downstream-url` to the target endpoint on Employment Hero's own API:

```bash
curl 'https://unify.apideck.com/proxy' \
  -H "Authorization: Bearer ${APIDECK_API_KEY}" \
  -H "x-apideck-app-id: ${APIDECK_APP_ID}" \
  -H "x-apideck-consumer-id: ${CONSUMER_ID}" \
  -H "x-apideck-service-id: employmenthero" \
  -H "x-apideck-downstream-url: <target endpoint on Employment Hero>" \
  -H "x-apideck-downstream-method: GET"
```

See [Employment Hero's API docs](https://developer.employmenthero.com) for available endpoints.

## Sibling connectors

Other **HRIS** connectors that share this unified API surface (same method signatures, just change `serviceId`):

[`bamboohr`](../bamboohr/), [`workday`](../workday/), [`deel`](../deel/) *(beta)*, [`hibob`](../hibob/), [`personio`](../personio/), [`adp-ihcm`](../adp-ihcm/) *(beta)*, [`adp-workforce-now`](../adp-workforce-now/) *(beta)*, [`paychex`](../paychex/) *(beta)*, and 49 more.

## See also

- [HRIS OpenAPI spec](https://specs.apideck.com/hris.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=hris)
- [`apideck-connector-coverage`](../../skills/apideck-connector-coverage/) — programmatic coverage checks
- [`apideck-best-practices`](../../skills/apideck-best-practices/) — architecture, Vault, pagination, error handling
- [`apideck-node`](../../skills/apideck-node/) — TypeScript / Node SDK patterns
- [Employment Hero official docs](https://developer.employmenthero.com)