# Sympa — HRIS API: overview

> Canonical URL: https://developers.apideck.com/apis/hris/sympa/overview

Sympa is a complete, fully customisable HR software that lets you focus on your people and smart decision-making. Explore our solution and book a.
- Status: live
- Authentication: basic

- **important to know:** Plan on a scheduled sync rather than near-real-time updates: Sympa sends no change events and caps each interface at a low hourly request volume.
- **supported resource categories:**   - **resources:** employees
  - **name:** People
  - **resources:** time-off-requests
  - **name:** Time Off
- **webhooks:** No webhooks - data is fetched by polling.
- **difficulty reason:** Sympa Technology Partner Programme + Key and Secret Assigned by Sympa
- **consumer access level:** A Sympa administrator able to obtain the interface's API key and secret.
- **rate limits:** 100 requests per hour per interface, shared across all request types.
- **partnership portal name:** Sympa Partner Programme
- **apideck credentials note:** Sympa issues the API key and secret itself, so there are no shared credentials.
- **partnership note:** Apply to the Technology Partner programme and accept Sympa's partnership terms; membership gives access to a Marketplace listing.
- **apideck credentials available:** false
- **partnership required:** true
- **responsibility matrix:**   - **area:** Join Sympa Technology Partner Programme
  - **customer:** ✓
  - **area:** Request Test Credentials
  - **customer:** ✓ From Sympa's partner team
  - **area:** Enable Connector in Apideck Dashboard
  - **customer:** ✓
  - **area:** Obtain API Key & Secret
  - **consumer:** ✓ From Sympa
  - **apideck:** Stores credentials, calls the API
  - **area:** Provide Credentials
  - **consumer:** ✓
- **costs:** Sympa publishes no fee for API access.
- **external guides:**   - **source:** Sympa
  - **title:** Sympa Generic API (Postman)
  - **url:** https://documenter.getpostman.com/view/33639379/2sA3kXG1vX
- **sandbox note:** Test credentials issued by Sympa's partner team on request (partners@sympa.com); no self-serve sandbox.
- **partnership url:** https://www.sympa.com/product/partner-programme/
- **difficulty:** involved
- **environment notes:**   - **description:** Sympa documents one API host (https://api.sympahr.net/api) for both test and production credentials; no separate sandbox host is documented.
  - **environment:** Single environment
- **sandbox available:** true
- **account type required:** A Sympa HRIS customer account with the Generic API interface enabled.
- **authentication note:** Not OAuth: the API key is sent as the username and the secret as the password.

## Supported resources

- **custom field support:** true
- **id:** employees
- **name:** Employees
- **downstream id:** employees
- **status:** live
- **downstream name:** Employees
- **downstream id:** absences
- **name:** Time Off Requests
- **downstream name:** Absences
- **status:** live
- **custom field support:** false
- **id:** time-off-requests

An omitted operation list does not establish operation support. Verify the selected operation in the coverage matrix.

[API reference](https://developers.apideck.com/apis/hris/reference.md) · [Coverage matrix](https://developers.apideck.com/apis/hris/coverage)
