For AI agents: visit https://docs.oysterhr.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Guides API Reference Changelog

Guides

Guides API Reference Changelog

Welcome

Welcome to the Oyster API

Using the Oyster API

Developer Sandbox
Understanding rate limiting
Getting started with webhooks
Understanding rulesets
Trace IDs
Errors
Deprecation
Async Operations

API Authorization

Customer guide to creating and authorizing a Developer Application
Partner guide to creating a Developer Application
Partner guide to authorizing access to developer application
Client credentials authorization

For Partners

Integration listing instructions
Oyster Partner SSO Requirements
Embeddable Web Components

For Resellers

Reseller guide to using the Oyster API

hiring

Creating and submitting an EOR employment
Completing EOR employment onboarding
Managing EOR employment agreements
Hiring API country coverage
Monitoring the EOR hire process

Benefits

Managing benefits

Time Off

Creating time off requests

Timesheets

Managing timesheets
Timesheets user actions

Invoicing and Payments

Invoicing at Oyster
Managing Invoices
Managing Payments

Offboarding

Offboarding an engagement

Powered by

Client credentials authorization