Hr Works

HR Works (via Apideck)

Access HR Works 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 HR Works plumbing.

Beta connector. HR Works 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: hr-works
• Unified API: HRIS
• Auth type: oauth2
• Status: beta
• Apideck setup guide: Connection guide
• Gotchas: page
• HR Works docs: https://www.hrworks.de
• Homepage: https://hrworks-inc.com/

When to use this skill

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

1. Which Apideck unified API covers HR Works (HRIS)
2. The correct serviceId to pass on every call (hr-works)
3. HR Works-specific auth and coverage caveats

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

• apideck-node, apideck-python, apideck-dotnet, apideck-java, apideck-go, apideck-php, or apideck-rest

For the raw OpenAPI spec:

• HRIS: https://specs.apideck.com/hris.yml · API Explorer

Minimal example (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 HR Works
const { data } = await apideck.hris.employees.list({
  serviceId: "hr-works",
});

Portable across 58 HRIS connectors

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

// Today — HR Works
await apideck.hris.employees.list({ serviceId: "hr-works" });

// 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 HR Works 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.

Setup guide: Apideck publishes a step-by-step guide for registering an OAuth app / configuring credentials for HR Works — see https://developers.apideck.com/connectors/hr-works/docs/consumer+connection. Use that as the authoritative source when walking users through connection setup.

See 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:

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

See 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 HR Works directly — Apideck injects auth headers and handles token refresh. Set x-apideck-downstream-url to the target endpoint on HR Works's own API:

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: hr-works" \
  -H "x-apideck-downstream-url: <target endpoint on HR Works>" \
  -H "x-apideck-downstream-method: GET"

See HR Works's API docs for available endpoints.

Sibling connectors

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

bamboohr, workday, deel (beta), hibob, personio, adp-ihcm (beta), adp-workforce-now (beta), paychex (beta), and 49 more.

See also

• Apideck connection guide for HR Works
• HRIS OpenAPI spec · API Explorer
• apideck-connector-coverage — programmatic coverage checks
• apideck-best-practices — architecture, Vault, pagination, error handling
• apideck-node — TypeScript / Node SDK patterns
• HR Works official docs