Oyster HR

Oyster HR Offboarding API

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

GitHub OpenAPI

Operations 14

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 #

Documentation

📖
Documentation
https://docs.oysterhr.com/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/oyster-hr/openapi/oyster-hr-offboarding-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/oyster-hr/json-schema/oyster-hr-offboarding-schema.json
📊
JSONSchema
https://artifacts.apis.io/oyster-hr/json-schema/oyster-hr-meta-schema.json
📊
JSONSchema
https://artifacts.apis.io/oyster-hr/json-schema/oyster-hr-offboardings-schema.json
📊
JSONSchema
https://artifacts.apis.io/oyster-hr/json-schema/oyster-hr-agreements-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/oyster-hr:oyster-hr-offboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oyster-hr-offboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Endpoints Offboarding API
  version: v1
servers:
- url: https://api.oysterhr.com
  description: Production server
- url: https://api-sandbox.oysterhr.com
  description: Sandbox server
tags:


# --- truncated at 32 KB (66 KB total) ---
# Full source: https://artifacts.apis.io/oyster-hr/openapi/oyster-hr-offboarding-api-openapi.yml