Sage HR (via Apideck)

Access Sage HR through Apideck's HRIS, ATS 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 Sage HR plumbing.

Quick facts

• Apideck serviceId: sage-hr
• Unified APIs: HRIS, ATS
• Auth type: apiKey
• Gotchas: HRIS · ATS
• Homepage: https://sage.hr/

At a glance

• Implementation difficulty: moderate — API Key Authentication - Each Consumer Enables API Access and Copies Their Own Key
• Vendor partnership required: no
• Apideck-managed credentials: not available — Each consumer supplies their own Sage HR subdomain and API key.
• Account type required: A Sage HR company account.
• Consumer access level: A Sage HR admin, since only admins can enable API access.
• Sandbox: available — Free 30-day Sage HR trial, no card required. Whether the API can be enabled during the trial is not confirmed.
• Authentication: Sent in the X-Auth-Token header; not OAuth.
• Webhooks: Virtual webhooks - employee created, updated and terminated (HRIS); applicant and job created and updated (ATS).

Important to know:

• Sage HR serves both the HRIS and ATS APIs, and Vault keys a connection to one unified API, so each vertical is a separate connection using the same subdomain and API key.
• The API key belongs to the admin who enabled API access and is tied to that person's admin rights: if they lose admin permissions, Sage HR invalidates the key and the connection stops working, so create it from a stable admin account.

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

When to use this skill

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

1. Which Apideck unified API covers Sage HR (HRIS, ATS)
2. The correct serviceId to pass on every call (sage-hr)
3. Sage HR-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
• ATS: https://specs.apideck.com/ats.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 Sage HR
const { data } = await apideck.hris.employees.list({
  serviceId: "sage-hr",
});

Portable across 58 HRIS connectors

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

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

// 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 Sage HR 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: API Key
• Managed by: Apideck Vault — the user pastes their Sage HR API key into the Vault modal; Apideck stores it encrypted and injects it on every request.
• Rotation: if the user rotates their key, they re-enter it in Vault. No code changes needed.

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/sage-hr' \
  -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 Sage HR directly — Apideck injects auth headers and handles token refresh. Set x-apideck-downstream-url to the target endpoint on Sage HR'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: sage-hr" \
  -H "x-apideck-downstream-url: <target endpoint on Sage HR>" \
  -H "x-apideck-downstream-method: GET"

See Sage HR'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.

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

greenhouse, workday, lever, workable (beta), bullhorn-ats (beta), teamtailor (beta), freshteam, jobadder (beta), and 2 more.

See also

• HRIS OpenAPI spec · API Explorer
• ATS OpenAPI spec · API Explorer
• apideck-connector-coverage — programmatic coverage checks
• apideck-best-practices — architecture, Vault, pagination, error handling
• apideck-node — TypeScript / Node SDK patterns