Breathehr

Breathe HR (via Apideck)

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

Quick facts

• Apideck serviceId: breathehr
• Unified API: HRIS
• Auth type: apiKey
• Gotchas: page
• Breathe HR docs: https://developer.breathehr.com
• Homepage: https://www.breathehr.com/

When to use this skill

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

1. Which Apideck unified API covers Breathe HR (HRIS)
2. The correct serviceId to pass on every call (breathehr)
3. Breathe 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

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 Breathe HR
const { data } = await apideck.hris.employees.list({
  serviceId: "breathehr",
});

Portable across 58 HRIS connectors

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

// Today — Breathe HR
await apideck.hris.employees.list({ serviceId: "breathehr" });

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

See Breathe 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.

See also

• 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
• Breathe HR official docs