folks-hr v1.0.0A

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

---
name: folks-hr
description: |
  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, payrolls, and time-off records in Folks HR. Routes through Apideck with serviceId "folks-hr".
license: Apache-2.0
alwaysApply: false
metadata:
  author: apideck
  version: "1.0.0"
  serviceId: folks-hr
  unifiedApis: ["hris"]
  authType: oauth2
  tier: "2"
  verified: true
  difficulty: moderate
  partnershipRequired: false
  sandboxAvailable: true
---

# 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

- **Apideck serviceId:** `folks-hr`
- **Unified API:** HRIS
- **Auth type:** oauth2
- **Gotchas:** [page](https://developers.apideck.com/apis/hris/folks-hr/gotchas)
- **Folks HR docs:** https://www.folkshr.com
- **Homepage:** https://folksrh.com/

## 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](https://support.folkshr.com/hc/en-ca/requests/new?ticket_form_id=22748731575188)) — 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:

- [`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 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.

```typescript
// 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`](../../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/folks-hr' \
  -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 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:

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

See [Folks HR's API docs](https://www.folkshr.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
- [Folks HR official docs](https://www.folkshr.com)