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

# Shireburn Indigo People API

API for HR and employee management. The API exposes 4 endpoints secured with apiKey authentication.

## For AI agents

Programmatically add a new employee, list employees. Covers 4 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for hr and recruiting only.

## Capabilities

- Add a new employee
- List employees
- Submit leave request
- Query and filter Shireburn Indigo People API records by parameters
- Monitor Shireburn Indigo People API operational status and events

## Use cases

### HR and Recruiting Operations

Use the Shireburn Indigo People API to perform hr recruiting operations programmatically. The API provides 4 endpoints covering core functionality including add a new employee, list employees, submit leave request.

Example prompt: Call POST /employees to add a new employee

### Automated employees Management

Automate employees operations by combining multiple Shireburn Indigo People API endpoints. Agents can list employees and then submit leave request in a single workflow.

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

### AI Agent Integration via Jentic

AI agents discover and call Shireburn Indigo People 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 'add a new employee', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/employees` | Add a new employee |
| GET | `/employees` | List employees |
| POST | `/leave-requests` | Submit leave request |
| GET | `/leave-requests` | List leave requests |

## Key resources

- **employees** — Operations related to employees
- **leave-requests** — Operations related to leave-requests

## 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:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 85 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 53 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/shireburn.com/shireburn/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 Shireburn Indigo People API by hand means placing your key in the Authorization header, pointing at the api.shireburn.com host, and threading it through employee and leave-request calls yourself. Through Jentic you install once, import the Shireburn Indigo People API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Shireburn Indigo People takes its inputs in the request body rather than as path resources, so scope the agent to the operations it needs, such as listing employees or creating a leave request, and leave out the ones it should not run.
- **Credential handling:** Your Shireburn Indigo People 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 'add a new employee' or 'create a leave request', and Jentic returns the matching Shireburn Indigo People operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Greenhouse** — Alternative hr recruiting API
- **Lever** — Alternative hr recruiting API
- **Workday** — Complementary hr recruiting API

## FAQ

### What authentication does the Shireburn Indigo People API use?

The Shireburn Indigo People API uses an API key passed in the `Authorization` 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 add a new employee with the Shireburn Indigo People 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 Shireburn Indigo People 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 add a new employee through Jentic?

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

### How many endpoints does the Shireburn Indigo People API have?

The Shireburn Indigo People API exposes 4 endpoints covering employees, leave-requests operations.

### Can I limit what my agent is allowed to do with the Shireburn Indigo People API?

Yes. Because Jentic One is self-hosted, you decide which of this API's operations your agent may call and which credentials it may use. Since the Shireburn Indigo People API takes its inputs in the request body rather than as path resources, you scope by operation: you can allow read-only calls like listing employees (GET /employees) or listing leave requests (GET /leave-requests) while withholding writes such as adding an employee (POST /employees) or submitting a leave request (POST /leave-requests). Only the operations you enable are exposed to the agent, and the stored key is injected at execution time under your rules.