humaans-io · diff

v1.0.0 to v1.0.0

22 added, 0 removed. Audit A to A.

---
name: humaans-io
description: |
Humaans 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 Humaans. Routes through Apideck with serviceId "humaans-io".
license: Apache-2.0
alwaysApply: false
metadata:
author: apideck
version: "1.0.0"
serviceId: humaans-io
unifiedApis: ["hris"]
authType: apiKey
tier: "2"
verified: true
status: beta
+ difficulty: moderate
+ partnershipRequired: false
+ sandboxAvailable: true
---
# Humaans (via Apideck)
Access Humaans 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 Humaans plumbing.
> **Beta connector.** Humaans 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:** `humaans-io`
- **Unified API:** HRIS
- **Auth type:** apiKey
- **Status:** beta
- **Apideck setup guide:** [Connection guide](https://developers.apideck.com/connectors/humaans-io/docs/consumer+connection)
- **Gotchas:** [page](https://developers.apideck.com/apis/hris/humaans-io/gotchas)
- **Humaans docs:** https://docs.humaans.io
- **Homepage:** https://humaans.io/
+
+ ## At a glance
+
+ - **Implementation difficulty:** moderate — API Token Authentication: Each Consumer Creates Their Own Token in Humaans
+ - **Vendor partnership required:** no
+ - **Apideck-managed credentials:** not available — Each consumer supplies their own Humaans API access token.
+ - **Account type required:** Humaans account on the Growth plan or above.
+ - **Consumer access level:** Owner role, since a token reaches only what its creator can; a user-role token sees only public company data and its creator's own profile.
+ - **Sandbox:** available ([signup](https://docs.google.com/forms/d/e/1FAIpQLSfvsENhiZgum1DTEsqM3-LSJaBM6Ee2e3zfW71YtW112iAGyw/viewform)) — Request an isolated sandbox account through Humaans' form; Humaans verifies the request, then emails the sandbox credentials.
+ - **Costs:** Included from the Growth plan (listed as Integrations & API access); Humaans publishes no prices, plans are sold through its sales team.
+ - **Rate limits:** Roughly 400 requests a minute per token.
+ - **Authentication:** Humaans API access token, sent as a bearer token.
+ - **Webhooks:** Virtual webhooks - employee created, updated and terminated events
+
+ **Important to know:**
+
+ - A Humaans token set to expire (1 to 365 days) stops working on that date with a 401 and cannot be renewed automatically, so the connection fails until the consumer creates a new token and updates it. A token created without an expiry avoids this.
+
+ > Facts synced from Apideck's connector metadata API — `GET /connector/connectors/humaans-io` (`overview` field) is the live, authoritative version.
## When to use this skill
Activate this skill when the user explicitly wants to work with **Humaans** — for example, "sync employees in Humaans" or "list time-off requests in Humaans". This skill teaches the agent:
1. Which Apideck unified API covers Humaans (HRIS)
2. The correct `serviceId` to pass on every call (`humaans-io`)
3. Humaans-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 Humaans
const { data } = await apideck.hris.employees.list({
serviceId: "humaans-io",
});
```
## Portable across 58 HRIS connectors
The Apideck **HRIS** unified API exposes the same methods for every connector in its catalog. Switching from Humaans to another HRIS connector is a one-string change — no rewrite, no new SDK.
```typescript
// Today — Humaans
await apideck.hris.employees.list({ serviceId: "humaans-io" });
// 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 Humaans 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 Humaans 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.
**Setup guide:** Apideck publishes a step-by-step guide for registering an OAuth app / configuring credentials for Humaans — see [https://developers.apideck.com/connectors/humaans-io/docs/consumer+connection](https://developers.apideck.com/connectors/humaans-io/docs/consumer+connection). Use that as the authoritative source when walking users through connection setup.
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/humaans-io' \
-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 Humaans directly — Apideck injects auth headers and handles token refresh. Set `x-apideck-downstream-url` to the target endpoint on Humaans'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: humaans-io" \
-H "x-apideck-downstream-url: <target endpoint on Humaans>" \
-H "x-apideck-downstream-method: GET"
```
See [Humaans's API docs](https://docs.humaans.io) 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
- [Apideck connection guide for Humaans](https://developers.apideck.com/connectors/humaans-io/docs/consumer+connection)
- [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
- [Humaans official docs](https://docs.humaans.io)