# CIPHR — HRIS API: overview

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

CIPHR's cloud-based HR software and HR systems help organisations stay connected and reduce admin, even when operating remotely.
- Status: beta
- Authentication: apiKey

- **partnership required:** false
- **difficulty reason:** API Key Authentication + No Public Developer Documentation
- **responsibility matrix:**   - **area:** Enable the connector in the Apideck Dashboard
  - **customer:** ✓
  - **consumer:** ✓
  - **customer:** Ask the consumer
  - **area:** Request a CIPHR test environment
  - **consumer:** ✓
  - **area:** Obtain the tenant's API key
  - **area:** Enter the subdomain and API key in Vault
  - **consumer:** ✓
  - **customer:** Implement Vault
  - **apideck:** ✓
  - **area:** Store credentials securely
- **consumer access level:** CIPHR publishes no minimum role for obtaining the API key.
- **important to know:** CIPHR publishes no public developer documentation and makes some fields visible in the API only when CIPHR enables them for the customer, so confirm field visibility with CIPHR before relying on it.
- **apideck credentials note:** Each consumer supplies their own CIPHR subdomain and API key.
- **difficulty:** moderate
- **sandbox available:** false
- **beta:** true
- **account type required:** A CIPHR account with API access enabled by CIPHR.
- **apideck credentials available:** false
- **sandbox note:** CIPHR provides test environments only under a commercial relationship, so request one through a consumer who is a CIPHR customer.
- **environment notes:**   - **environment:** Single environment
  - **description:** Each connection reads one live CIPHR tenant on the consumer's own subdomain; without a CIPHR test environment, testing uses real HR data.
- **authentication note:** Sent in the apikey header; not OAuth.
- **supported resource categories:**   - **resources:** employees
  - **name:** People
- **webhooks:** No webhooks - data is read by polling.

## Supported resources

- **id:** employees
- **downstream id:** person-detail
- **custom field support:** true
- **status:** live
- **name:** Employees
- **downstream name:** Person Detail

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)