# Oyster HR Offboarding API

**Canonical:** https://apis.io/apis/oyster-hr/oyster-hr-offboarding-api/  
**Provider:** Oyster HR — https://apis.io/providers/oyster-hr/  
**Base URL:** https://api.oysterhr.com/v1  
**Documentation:** https://www.oysterhr.com/developer-api

Oyster HR Offboarding API is one of 24 APIs that [Oyster HR](https://apis.io/providers/oyster-hr/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 7 JSON Schema definitions. Tagged areas include Offboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

The Offboarding API from Oyster HR — 14 operation(s) for offboarding.

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/offboardings/` | Returns list of offboardings |
| POST | `/v1/offboardings/contractors/resignations` | Create a draft resignation for a contractor |
| POST | `/v1/offboardings/contractors/terminations` | Create a draft termination for a contractor |
| POST | `/v1/offboardings/employments/resignations` | Create a draft resignation for an employment |
| POST | `/v1/offboardings/employments/terminations` | Create a draft termination for an employment |
| POST | `/v1/offboardings/payroll_team_members/terminations` | Create a draft termination for a payroll team member |
| GET | `/v1/offboardings/payroll_team_members/terminations/rulesets` | Retrieve rulesets for drafting an offboarding for a payroll team member |
| GET | `/v1/offboardings/sources/{employment_type}/categories` | Returns list of offboarding categories |
| GET | `/v1/offboardings/sources/{employment_type}/pay_types` | Returns list of offboarding pay types |
| GET | `/v1/offboardings/{id}` | Returns an offboarding |
| GET | `/v1/offboardings/{id}/agreements` | Returns list of agreements for an offboarding |
| POST | `/v1/offboardings/{id}/cancellation` | Request cancellation for an initiated offboarding |
| POST | `/v1/offboardings/{id}/documents` | Attach documents to a draft offboarding |
| POST | `/v1/offboardings/{id}/initiate` | Initiate offboarding |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/oyster-hr/refs/heads/main/openapi/oyster-hr-offboarding-api-openapi.yml
- **Documentation** — https://docs.oysterhr.com/
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/oyster-hr/refs/heads/main/json-schema/oyster-hr-token-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/oyster-hr/refs/heads/main/json-schema/oyster-hr-employment-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/oyster-hr/refs/heads/main/json-schema/oyster-hr-contract-change-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/oyster-hr/refs/heads/main/json-schema/oyster-hr-employment-cost-estimate-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/oyster-hr/refs/heads/main/json-schema/oyster-hr-engagement-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/oyster-hr/refs/heads/main/json-schema/oyster-hr-time-tracking-time-sheet-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/oyster-hr/refs/heads/main/json-schema/oyster-hr-time-tracking-time-sheets-schema.json

## Other Oyster HR APIs (12)

- [Oyster HR Authentication API](https://apis.io/apis/oyster-hr/oyster-hr-authentication-api/)
- [Oyster HR Bank Accounts API](https://apis.io/apis/oyster-hr/oyster-hr-bank-accounts-api/)
- [Oyster HR Benefits API](https://apis.io/apis/oyster-hr/oyster-hr-benefits-api/)
- [Oyster HR Company API](https://apis.io/apis/oyster-hr/oyster-hr-company-api/)
- [Oyster HR Consent API](https://apis.io/apis/oyster-hr/oyster-hr-consent-api/)
- [Oyster HR Contract Changes API](https://apis.io/apis/oyster-hr/oyster-hr-contract-changes-api/)
- [Oyster HR Cost Estimate API](https://apis.io/apis/oyster-hr/oyster-hr-cost-estimate-api/)
- [Oyster HR Credit notes API](https://apis.io/apis/oyster-hr/oyster-hr-credit-notes-api/)
- [Oyster HR Departments API](https://apis.io/apis/oyster-hr/oyster-hr-departments-api/)
- [Oyster HR Employments API](https://apis.io/apis/oyster-hr/oyster-hr-employments-api/)
- [Oyster HR Engagements API](https://apis.io/apis/oyster-hr/oyster-hr-engagements-api/)
- [Oyster HR Expenses API](https://apis.io/apis/oyster-hr/oyster-hr-expenses-api/)

## Tags

Offboarding

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/oyster-hr/oyster-hr-offboarding-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/oyster-hr/.