v1.0.0 to v1.0.0

---

name: sympa

description: |

Sympa 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 Sympa. Routes through Apideck with serviceId "sympa".

license: Apache-2.0

alwaysApply: false

metadata:

author: apideck

version: "1.0.0"

serviceId: sympa

unifiedApis: ["hris"]

authType: basic

tier: "2"

verified: true

---

# Sympa (via Apideck)

Access Sympa 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 Sympa plumbing.

## Quick facts

- **Apideck serviceId:** `sympa`

- **Unified API:** HRIS

- **Auth type:** basic

- **Gotchas:** [page](https://developers.apideck.com/apis/hris/sympa/gotchas)

- **Sympa docs:** https://www.sympa.com

- **Homepage:** https://www.sympa.com/

## When to use this skill

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

1. Which Apideck unified API covers Sympa (HRIS)

2. The correct `serviceId` to pass on every call (`sympa`)

3. Sympa-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 Sympa

const { data } = await apideck.hris.employees.list({

serviceId: "sympa",

});

```

## Portable across 58 HRIS connectors

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

```typescript

// Today — Sympa

await apideck.hris.employees.list({ serviceId: "sympa" });

// 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 Sympa 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:** Basic auth (username/password)

- **Managed by:** Apideck Vault — credentials are collected through the Vault modal and stored encrypted server-side.

- **Note:** basic auth connectors often require manual rotation by the end user. If auth fails persistently, prompt them to re-enter credentials in Vault.

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/sympa' \

-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 Sympa directly — Apideck injects auth headers and handles token refresh. Set `x-apideck-downstream-url` to the target endpoint on Sympa'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: sympa" \

-H "x-apideck-downstream-url: <target endpoint on Sympa>" \

-H "x-apideck-downstream-method: GET"

```

See [Sympa's API docs](https://www.sympa.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

- [Sympa official docs](https://www.sympa.com)