Oyster HR

Oyster HR Operations API

The Operations API from Oyster HR — 1 operation(s) for operations.

Documentation GitHub OpenAPI

Operations 1

GET /v1/meta/operations/{operation_key} Retrieve an operation #

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-operations-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

openapi: 3.2.0
info:
  title: Endpoints Operations API
  version: v1
servers:
- url: https://api.oysterhr.com
  description: Production server
- url: https://api-sandbox.oysterhr.com
  description: Sandbox server
tags:
- name: Operations
paths:
  /v1/meta/operations/{operation_key}:
    get:
      summary: Retrieve an operation
      tags:
      - Operations
      description: Returns details for an operation with a given operation key.
      security:
      - bearer_auth:
        - read
      parameters:
      - name: operation_key
        in: path
        description: Operation key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                Successful:
                  value:
                    request:
                      method: GET
                      path: /resources
                      queryParams:
                        foo: bar
                        apiVersion: v0.1
                      responseCode: 200
                    data:
                      foo: bar
                      bar: baz
                    meta:
                      completed: true
                      success: true
              schema:
                $ref: '#/components/schemas/operation'
      operationId: getV1MetaOperationsByOperationKey
      x-operation-id-source: derived
components:
  schemas:
    operation:
      type: object
      properties:
        request:
          type: object
          properties:
            method:
              type: string
            path:
              type: string
            queryParams:
              type: object
              required:
              - apiVersion
            responseCode:
              type: integer
          required:
          - method
          - path
          - queryParams
          - responseCode
        data:
          type: object
        meta:
          type: object
          properties:
            completed:
              type: boolean
            success:
              type: boolean
            idempotencyKey:
              type: string
              description: The idempotency key this operation claimed.
      required:
      - request
      - data
      - meta
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
x-provenance:
  method: searched
  source: https://docs.oysterhr.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.oysterhr.com/reference/delete_v1-bank-accounts-id.md
  - https://docs.oysterhr.com/reference/delete_v1-consent-grants.md
  - https://docs.oysterhr.com/reference/delete_v1-expenses-id.md
  - https://docs.oysterhr.com/reference/delete_v1-hiring-employments-id-commission-plan.md
  - https://docs.oysterhr.com/reference/delete_v1-hiring-employments-id-document-document-id.md
  - https://docs.oysterhr.com/reference/delete_v1-hiring-employments-id-work-permit.md
  - https://docs.oysterhr.com/reference/delete_v1-hiring-employments-id.md
  - https://docs.oysterhr.com/reference/delete_v1-payments-charge-groups-id-wire-sent.md
  - https://docs.oysterhr.com/reference/delete_v1-payroll-changes-id.md
  - https://docs.oysterhr.com/reference/delete_v1-time-tracking-time-sheets-entries-id.md
  - https://docs.oysterhr.com/reference/delete_v1-time-tracking-time-sheets-id.md
  - https://docs.oysterhr.com/reference/delete_v1-webhooks-id.md
  - https://docs.oysterhr.com/reference/get_v1-bank-accounts-id.md
  - https://docs.oysterhr.com/reference/get_v1-bank-accounts-rulesets.md
  - https://docs.oysterhr.com/reference/get_v1-bank-accounts.md
  - https://docs.oysterhr.com/reference/get_v1-benefits-engagements-engagement-id-offerings.md
  - https://docs.oysterhr.com/reference/get_v1-benefits-enrollments-id.md
  - https://docs.oysterhr.com/reference/get_v1-benefits-ruleset.md
  - https://docs.oysterhr.com/reference/get_v1-company.md
  - https://docs.oysterhr.com/reference/get_v1-contract-changes-id.md
  - https://docs.oysterhr.com/reference/get_v1-contract-changes-rulesets.md
  - https://docs.oysterhr.com/reference/get_v1-contract-changes.md
  - https://docs.oysterhr.com/reference/get_v1-credit-notes-identifier.md
  - https://docs.oysterhr.com/reference/get_v1-credit-notes-sources-statuses.md
  - https://docs.oysterhr.com/reference/get_v1-credit-notes-sources-types.md
  - https://docs.oysterhr.com/reference/get_v1-credit-notes.md
  - https://docs.oysterhr.com/reference/get_v1-departments.md
  - https://docs.oysterhr.com/reference/get_v1-engagements-id-allowances.md
  - https://docs.oysterhr.com/reference/get_v1-engagements-id-bonuses.md
  - https://docs.oysterhr.com/reference/get_v1-engagements-id-documents.md
  - https://docs.oysterhr.com/reference/get_v1-engagements-id-identity-verification.md
  - https://docs.oysterhr.com/reference/get_v1-engagements-id-payslips.md
  - https://docs.oysterhr.com/reference/get_v1-engagements-id.md
  - https://docs.oysterhr.com/reference/get_v1-engagements.md
  - https://docs.oysterhr.com/reference/get_v1-expenses-id.md
  - https://docs.oysterhr.com/reference/get_v1-expenses-ruleset.md
  - https://docs.oysterhr.com/reference/get_v1-expenses-rulesets-id-sources-categories.md
  - https://docs.oysterhr.com/reference/get_v1-expenses-rulesets-id.md
  - https://docs.oysterhr.com/reference/get_v1-expenses.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-agreements-agreement-id.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-agreements.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-cost-estimates-annually.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-cost-estimates-monthly.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-onboarding-form-documents-field-or-document-id.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-onboarding-form.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-id-tasks.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-id.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-onboarding-form.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-employments-rulesets.md
  - https://docs.oysterhr.com/reference/get_v1-hiring-role-types.md
  - https://docs.oysterhr.com/reference/get_v1-invoices-identifier-breakdown.md
  - https://docs.oysterhr.com/reference/get_v1-invoices-identifier.md
  - https://docs.oysterhr.com/reference/get_v1-invoices-sources-statuses.md
  - https://docs.oysterhr.com/reference/get_v1-invoices-sources-types.md
  - https://docs.oysterhr.com/reference/get_v1-invoices.md
  - https://docs.oysterhr.com/reference/get_v1-meta-operations-operation-key.md
  - https://docs.oysterhr.com/reference/get_v1-offboardings-id-agreements.md
  - https://docs.oysterhr.com/reference/get_v1-offboardings-id.md
  - https://docs.oysterhr.com/reference/get_v1-offboardings-payroll-team-members-terminations-rulesets.md
  - https://docs.oysterhr.com/reference/get_v1-offboardings-sources-employment-type-categories.md
  - https://docs.oysterhr.com/reference/get_v1-offboardings-sources-employment-type-pay-types.md
  - https://docs.oysterhr.com/reference/get_v1-offboardings.md
  - https://docs.oysterhr.com/reference/get_v1-payments-charge-groups-id-charges.md
  - https://docs.oysterhr.com/reference/get_v1-payments-charge-groups-id.md
  - https://docs.oysterhr.com/reference/get_v1-payments-charge-groups.md
  - https://docs.oysterhr.com/reference/get_v1-payments-charges-id.md
  - https://docs.oysterhr.com/reference/get_v1-payments-payouts-id.md
  - https://docs.oysterhr.com/reference/get_v1-payroll-changes-id.md
  - https://docs.oysterhr.com/reference/get_v1-payroll-changes-ruleset.md
  - https://docs.oysterhr.com/reference/get_v1-payroll-changes-rulesets-default-sources-types.md
  - https://docs.oysterhr.com/reference/get_v1-payroll-changes-rulesets-default.md
  - https://docs.oysterhr.com/reference/get_v1-payroll-changes-sources-types.md
  - https://docs.oysterhr.com/reference/get_v1-payroll-changes.md
  - https://docs.oysterhr.com/reference/get_v1-payroll-id-records.md
  - https://docs.oysterhr.com/reference/get_v1-payroll-id.md
  - https://docs.oysterhr.com/reference/get_v1-payroll.md
  - https://docs.oysterhr.com/reference/get_v1-public-holidays.md
  - https://docs.oysterhr.com/reference/get_v1-reseller-customers.md
  - https://docs.oysterhr.com/reference/get_v1-time-off-entitlements-id.md
  - https://docs.oysterhr.com/reference/get_v1-time-off-entitlements.md
  - https://docs.oysterhr.com/reference/get_v1-time-off-requests-id.md
  - https://docs.oysterhr.com/reference/get_v1-time-off-requests.md
  - https://docs.oysterhr.com/reference/get_v1-time-tracking-rulesets-engagement-id-sources-source-type.md
  - https://docs.oysterhr.com/reference/get_v1-time-tracking-rulesets-engagement-id.md
  - https://docs.oysterhr.com/reference/get_v1-time-tracking-time-sheets-id.md
  - https://docs.oysterhr.com/reference/get_v1-time-tracking-time-sheets.md
  - https://docs.oysterhr.com/reference/get_v1-webhooks-dispatches.md
  - https://docs.oysterhr.com/reference/get_v1-webhooks.md
  - https://docs.oysterhr.com/reference/patch_v1-bank-accounts-id.md
  - https://docs.oysterhr.com/reference/patch_v1-employments-id-personal-details.md
  - https://docs.oysterhr.com/reference/patch_v1-hiring-employments-id-onboarding-form.md
  - https://docs.oysterhr.com/reference/patch_v1-hiring-employments-id.md
  - https://docs.oysterhr.com/reference/patch_v1-payroll-changes-id.md
  - https://docs.oysterhr.com/reference/patch_v1-reseller-customers-id.md
  - https://docs.oysterhr.com/reference/patch_v1-time-tracking-time-sheets-entries-id.md
  - https://docs.oysterhr.com/reference/patch_v1-webhooks-id.md
  - https://docs.oysterhr.com/reference/post_v1-bank-accounts.md
  - https://docs.oysterhr.com/reference/post_v1-benefits-engagements-engagement-id-enrollments.md
  - https://docs.oysterhr.com/reference/post_v1-consent-grants.md
  - https://docs.oysterhr.com/reference/post_v1-contract-changes-id-cancel.md
  - https://docs.oysterhr.com/reference/post_v1-contract-changes.md
  - https://docs.oysterhr.com/reference/post_v1-engagements-id-identity-verification-approved.md
  - https://docs.oysterhr.com/reference/post_v1-engagements-id-identity-verification-declined.md
  - https://docs.oysterhr.com/reference/post_v1-engagements-id-identity-verification-sessions.md
  - https://docs.oysterhr.com/reference/post_v1-expenses-id-approve.md
  - https://docs.oysterhr.com/reference/post_v1-expenses-id-decline.md
  - https://docs.oysterhr.com/reference/post_v1-expenses.md
  - https://docs.oysterhr.com/reference/post_v1-hiring-employments-id-agreements-agreement-id-verify.md
  - https://docs.oysterhr.com/reference/post_v1-hiring-employments-id-commission-plan.md
  - https://docs.oysterhr.com/reference/post_v1-hiring-employments-id-document.md
  - https://docs.oysterhr.com/reference/post_v1-hiring-employments-id-onboarding-form-complete.md
  - https://docs.oysterhr.com/reference/post_v1-hiring-employments-id-submit.md
  - https://docs.oysterhr.com/reference/post_v1-hiring-employments-id-team-member-invite.md
  - https://docs.oysterhr.com/reference/post_v1-hiring-employments-id-work-permit.md
  - https://docs.oysterhr.com/reference/post_v1-hiring-employments.md
  - https://docs.oysterhr.com/reference/post_v1-invoices-identifier-approve.md
  - https://docs.oysterhr.com/reference/post_v1-invoices-identifier-dispute.md
  - https://docs.oysterhr.com/reference/post_v1-offboardings-contractors-resignations.md
  - https://docs.oysterhr.com/reference/post_v1-offboardings-contractors-terminations.md
  - https://docs.oysterhr.com/reference/post_v1-offboardings-employments-resignations.md
  - https://docs.oysterhr.com/reference/post_v1-offboardings-employments-terminations.md
  - https://docs.oysterhr.com/reference/post_v1-offboardings-id-cancellation.md
  - https://docs.oysterhr.com/reference/post_v1-offboardings-id-documents.md
  - https://docs.oysterhr.com/reference/post_v1-offboardings-id-initiate.md
  - https://docs.oysterhr.com/reference/post_v1-offboardings-payroll-team-members-terminations.md
  - https://docs.oysterhr.com/reference/post_v1-payments-charge-groups-id-wire-sent.md
  - https://docs.oysterhr.com/reference/post_v1-payroll-changes.md
  - https://docs.oysterhr.com/reference/post_v1-reseller-customers.md
  - https://docs.oysterhr.com/reference/post_v1-time-off-requests-id-approve.md
  - https://docs.oysterhr.com/reference/post_v1-time-off-requests-id-attachment.md
  - https://docs.oysterhr.com/reference/post_v1-time-off-requests-id-cancel.md
  - https://docs.oysterhr.com/reference/post_v1-time-off-requests-id-reject.md
  - https://docs.oysterhr.com/reference/post_v1-time-off-requests.md
  - https://docs.oysterhr.com/reference/post_v1-time-tracking-time-sheets-entries.md
  - https://docs.oysterhr.com/reference/post_v1-time-tracking-time-sheets-id-confirm.md
  - https://docs.oysterhr.com/reference/post_v1-time-tracking-time-sheets-id-submit.md
  - https://docs.oysterhr.com/reference/post_v1-time-tracking-time-sheets.md
  - https://docs.oysterhr.com/reference/post_v1-webhooks-id-test.md
  - https://docs.oysterhr.com/reference/post_v1-webhooks.md
  - https://docs.oysterhr.com/reference/put_v1-hiring-employments-id-onboarding-form-documents-field-id.md
  merge:
    pages: 140
    deduped: 378
    conflicts_kept_first: 0