namely · diff

v1.0.0 to v1.0.0

21 added, 0 removed. Audit A to A.

---
name: namely
description: |
Namely 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 Namely. Routes through Apideck with serviceId "namely".
license: Apache-2.0
alwaysApply: false
metadata:
author: apideck
version: "1.0.0"
serviceId: namely
unifiedApis: ["hris"]
authType: oauth2
tier: "2"
verified: true
+ difficulty: moderate
+ partnershipRequired: false
+ sandboxAvailable: false
---
# Namely (via Apideck)
Access Namely 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 Namely plumbing.
## Quick facts
- **Apideck serviceId:** `namely`
- **Unified API:** HRIS
- **Auth type:** oauth2
- **Gotchas:** [page](https://developers.apideck.com/apis/hris/namely/gotchas)
- **Namely docs:** https://developers.namely.com
- **Homepage:** https://www.namely.com/
+
+ ## At a glance
+
+ - **Implementation difficulty:** moderate — Partner Enquiry or Admin Access Needed for OAuth Credentials
+ - **Vendor partnership required:** no ([developer portal](https://namely.com/partners/)) — Namely's partner page takes integration enquiries at hello@namely.com.
+ - **Apideck-managed credentials:** not available — Apideck holds no Namely OAuth app.
+ - **Account type required:** Paid Namely account with API access enabled.
+ - **Consumer access level:** A Namely administrator, or a user an administrator has granted API access.
+ - **Sandbox:** not available — Test against a live Namely account; Namely documents no public route to request a sandbox tenant.
+ - **Rate limits:** 100 requests per minute on GET /profiles.
+ - **Authentication:** Authorization Code flow.
+ - **Webhooks:** Virtual webhooks - employee created, updated and terminated events.
+
+ **Important to know:**
+
+ - You connect Namely with your own OAuth client ID and secret. Sources disagree on whether a tenant admin can create these directly or they come through Namely's partner route, so confirm the route with Namely before you plan around it.
+
+ > Facts synced from Apideck's connector metadata API — `GET /connector/connectors/namely` (`overview` field) is the live, authoritative version.
## When to use this skill
Activate this skill when the user explicitly wants to work with **Namely** — for example, "sync employees in Namely" or "list time-off requests in Namely". This skill teaches the agent:
1. Which Apideck unified API covers Namely (HRIS)
2. The correct `serviceId` to pass on every call (`namely`)
3. Namely-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 Namely
const { data } = await apideck.hris.employees.list({
serviceId: "namely",
});
```
## Portable across 58 HRIS connectors
The Apideck **HRIS** unified API exposes the same methods for every connector in its catalog. Switching from Namely to another HRIS connector is a one-string change — no rewrite, no new SDK.
```typescript
// Today — Namely
await apideck.hris.employees.list({ serviceId: "namely" });
// 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 Namely 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/namely' \
-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 Namely directly — Apideck injects auth headers and handles token refresh. Set `x-apideck-downstream-url` to the target endpoint on Namely'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: namely" \
-H "x-apideck-downstream-url: <target endpoint on Namely>" \
-H "x-apideck-downstream-method: GET"
```
See [Namely's API docs](https://developers.namely.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
- [Namely official docs](https://developers.namely.com)