Oyster HR

Oyster HR Employments API

The Employments API from Oyster HR — 20 operation(s) for employments.

GitHub OpenAPI

Operations 25

PATCH /v1/employments/{id}/personal_details Update personal details #
POST /v1/hiring/employments Create employment #
GET /v1/hiring/employments/onboarding/form Fetch the onboarding form for a country #
GET /v1/hiring/employments/rulesets Rulesets for updating employment of particular country and subdivision #
GET /v1/hiring/employments/{id} Retrieve an individual employment #
PATCH /v1/hiring/employments/{id} Update employment #
DELETE /v1/hiring/employments/{id} Delete employment #
GET /v1/hiring/employments/{id}/agreements Retrieve all agreements for an employment #
GET /v1/hiring/employments/{id}/agreements/{agreement_id} Retrieve an individual agreement #
POST /v1/hiring/employments/{id}/agreements/{agreement_id}/verify Verify agreement #
POST /v1/hiring/employments/{id}/commission_plan Upload Employment Commission Plan #
DELETE /v1/hiring/employments/{id}/commission_plan Delete The Uploaded Employment Commission Plan #
POST /v1/hiring/employments/{id}/document Upload Employment Document #
DELETE /v1/hiring/employments/{id}/document/{document_id} Delete The Uploaded Employment Document #
GET /v1/hiring/employments/{id}/onboarding/form Fetch the onboarding form for an employment #
PATCH /v1/hiring/employments/{id}/onboarding/form Update the onboarding form #
POST /v1/hiring/employments/{id}/onboarding/form/complete Mark onboarding form as complete #
PUT /v1/hiring/employments/{id}/onboarding/form/documents/{field_id} Upload a document to the onboarding form #
GET /v1/hiring/employments/{id}/onboarding/form/documents/{field_or_document_id} Get a document from the onboarding form #
POST /v1/hiring/employments/{id}/submit Submit employment #
GET /v1/hiring/employments/{id}/tasks Get hiring process tasks for an employment #
POST /v1/hiring/employments/{id}/team_member/invite Invite team member #
POST /v1/hiring/employments/{id}/work_permit Upload Employment Work Permit #
DELETE /v1/hiring/employments/{id}/work_permit Delete The Uploaded Employment Work Permit #
GET /v1/hiring/role_types Role types for updating employment #

Documentation

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

Specifications

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

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/oyster-hr/json-schema/oyster-hr-employment-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-employments-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-employments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Endpoints Employments 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 (213 KB total) ---
# Full source: https://artifacts.apis.io/oyster-hr/openapi/oyster-hr-employments-api-openapi.yml