canonical: https://jentic.com/apis/sagehr.com/sagehr

# Sage HR API

All requests are required to be sent to your subdomain. To learn how to enable API in your Sage HR account, please visit https://support.sage.hr/en/articles/3246469-how-does-cakehr-api-work. The API exposes 67 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create new employee, list active employees in company. Covers 67 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Create new employee
- List active employees in company
- Single active employee in company
- Update Employee
- Employee custom fields
- Terminate employee

## Use cases

### CRM Operations

Use the Sage HR API to perform crm operations programmatically. The API provides 67 endpoints covering core functionality including create new employee, list active employees in company, single active employee in company.

Example prompt: Call POST /employees to create new employee

### Automated Documents Management

Automate documents operations by combining multiple Sage HR API endpoints. Agents can list active employees in company and then single active employee in company in a single workflow.

Example prompt: Call GET /employees to list active employees in company, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Sage HR API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'create new employee', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/employees` | Create new employee |
| GET | `/employees` | List active employees in company |
| GET | `/employees/{id}` | Single active employee in company |
| PUT | `/employees/{id}` | Update Employee |
| GET | `/employees/{id}/custom-fields` | Employee custom fields |
| PUT | `/employees/{id}/custom-fields/{custom_field_id}` | Update custom field |
| POST | `/employees/{id}/terminations` | Terminate employee |
| POST | `/employees/{id}/rehire` | Rehire employee |

## Key resources

- **Documents** — Operations for documents
- **Employees** — Operations for employees
- **Leave Management** — Operations for leave management
- **Offboarding** — Operations for offboarding
- **Onboarding** — Operations for onboarding

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 46 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 73 / 100
  - Developer Experience & Jentic Compatibility: 57 / 100
  - AI-Readiness & Agent Experience: 25 / 100
  - Agent Usability: 91 / 100
  - Security: 50 / 100
  - AI Discoverability: 49 / 100
- **View full report:** https://jentic.com/apis/sagehr.com/sagehr/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Sage HR API by hand means managing its API key, attaching it to each call against the sage.hr host, and handling your own retries. Through Jentic you install once, import the Sage HR API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Sage HR puts the employee id in the URL path (`/employees/{id}/...`), so a rule can pin your agent to one employee: it can read and update that employee and their custom fields and nothing else. You choose the operations it may call, so destructive ones like termination or rehire are not included unless you add them.
- **Credential handling:** Your Sage HR API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a new employee' or 'update an employee's custom field', and Jentic returns the matching Sage HR API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Sage HR API use?

The Sage HR API uses an API key passed in the `X-Auth-Token` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create new employee with the Sage HR API?

Yes. Use the POST /employees endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Sage HR API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create new employee through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create new employee'. Jentic returns the matching Sage HR API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Sage HR API have?

The Sage HR API exposes 67 endpoints covering documents, employees, leave management operations.

### Can I limit what my agent is allowed to do with the Sage HR API?

Yes. Because you run Jentic One yourself and set the rules, you decide exactly which Sage HR operations your agent may call and which stored credentials it may use. Since the employee id sits in the URL path (`/employees/{id}/...`), you can pin the agent to a single employee so it only reads and updates that employee and their custom fields. You also choose the operation set, so destructive calls like POST `/employees/{id}/terminations` or POST `/employees/{id}/rehire` stay out of reach unless you explicitly grant them.