# Oyster HR Employments API

**Canonical:** https://apis.io/apis/oyster-hr/oyster-hr-employments-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 Employments 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 Employments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

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

## Operations (25)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/oyster-hr/refs/heads/main/openapi/oyster-hr-employments-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 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/)
- [Oyster HR Identity Verification API](https://apis.io/apis/oyster-hr/oyster-hr-identity-verification-api/)

## Tags

Employments

---

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