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

# Oysterhr Endpoints

Oyster uses OAuth2 to enable customers to grant access to their data to third party applications. Customers also need to use this API to authenticate themselves when making API requests.

## For AI agents

Oyster uses OAuth2 to enable customers to grant access to their data to third party applications. Customers also need to use this API to authenticate themselves when making API requests.

## Scope

Provides access to Endpoints functionality as defined in the OpenAPI specification.

## Capabilities

- Create an access token
- Approve expense
- Decline expense
- Retrieve an individual expense
- Create expense

## Use cases

### Basic Endpoints Integration

Integrate Endpoints into your application to access its core functionality.

Example prompt: Use the Endpoints API to access vendor services and data.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /oauth2/token | Create an access token |
| POST | /v1/expenses/{id}/approve | Approve expense |
| POST | /v1/expenses/{id}/decline | Decline expense |
| GET | /v1/expenses/{id} | Retrieve an individual expense |
| POST | /v1/expenses | Create expense |
| GET | /v1/company | Retrieve company details |
| GET | /v1/departments | Retrieve all departments |

## Key resources

- **Main API** — Primary Endpoints resources and operations

## Why Jentic

- **Setup:** Wiring the Oyster HR API by hand means minting a bearer token through /oauth2/token and carrying it on every expense, company, and department call. Through Jentic you install once, import the Oyster HR API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Oyster HR puts the expense id in the URL path (/v1/expenses/{id}), so a rule can pin your agent to one expense for the reads and actions you allow. You choose the operations it may call, so approving or declining an expense is not included unless you add it.
- **Credential handling:** Your Oyster HR bearer token 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 an expense' or 'list departments', and Jentic returns the matching Oyster HR operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## FAQ

### What authentication does the Endpoints use?

The Endpoints uses bearer authentication.

### How many endpoints does the Endpoints have?

The Endpoints has 17 endpoints available.

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

Yes. Because you run Jentic One yourself, your own rules decide which Oyster HR operations and credentials the agent may use. Oyster HR puts the expense id in the URL path, such as /v1/expenses/{id}, so you can pin the agent to a single expense for the reads and actions you allow. You choose the operations it can call, so approving or declining an expense is excluded unless you explicitly add those endpoints.