folks-hr

Folks HR 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,

SKILL.md

GitHub

Folks HR (via Apideck)

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

Quick facts

At a glance

  • Implementation difficulty: moderate — Folks Must Activate API Access on Request
  • Vendor partnership required: no — API access is granted through Folks' request form, not a partner programme.
  • Apideck-managed credentials: not available — Each Folks company generates its own API key.
  • Account type required: A Folks HR company account with the API key management page activated.
  • Consumer access level: Company administrator; only administrators can generate API keys.
  • Sandbox: available (signup) — Request it through Folks' API request form, choosing Sandbox as the access type.
  • Rate limits: 60 requests per minute per client.
  • Authentication: Client ID and secret from a Folks V2 API key, plus the company UUID.
  • Webhooks: Virtual webhooks - employee created, updated and terminated events.

Important to know:

  • Production access is its own request, which Folks reviews with heightened security measures. Sandbox access alone does not let you go live, so plan for that vendor approval before launch.
  • Each API key carries access levels for employees, departments, working sites and sensitive data, chosen by the consumer's administrator. A key without the levels you need limits what you can read, and editing a key later invalidates the access tokens already issued from it.

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

When to use this skill

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

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

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

For the raw OpenAPI spec:

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

Portable across 58 HRIS connectors

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

// Today — Folks HR
await apideck.hris.employees.list({ serviceId: "folks-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 Folks 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: 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 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/folks-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 Folks HR directly — Apideck injects auth headers and handles token refresh. Set x-apideck-downstream-url to the target endpoint on Folks 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: folks-hr" \
  -H "x-apideck-downstream-url: <target endpoint on Folks HR>" \
  -H "x-apideck-downstream-method: GET"

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