oysterhr.com
Oyster is a global employment platform that helps companies hire, pay, and manage employees and contractors across many countries. It offers employer-of-record, payroll, contractor management, and related HR services.
Oyster exposes a documented REST API at https://api.oysterhr.com, authenticated with OAuth 2.0 Developer Applications (authorization code or restricted client credentials); some client-credentials calls also require `X-Oyster-Actor-Email`.
- Oyster APIdiscovered
Create an Oyster Developer App from the Oyster app's Developer tab as described in the customer guide or partner guide. After you submit the app, copy the Client ID and Client secret; the secret is only shown once in plain text and can later be regenerated from the Developer Applications list. For customer/partner integrations that access company data, have a Company Admin authorize the app via its Authorization URL, then exchange the returned code at POST https://api.oysterhr.com/oauth2/token per the customer guide. For restricted internal/partner use cases, Oyster also supports the client credentials grant as described in Client credentials authorization.
For certain endpoints used with client-credentials authentication, include the email address of a User with an Administrator role in the Oyster account in the X-Oyster-Actor-Email header, as documented in Client credentials authorization. This is not minted separately; use an existing Oyster admin user's email address.
conventions · 1/8 published
- integrations.json✗
/.well-known/integrations.json - llms.txt✓https://oysterhr.com/llms.txt
- API catalog✗
/.well-known/api-catalog - OpenAPI document✗
/api/schema/, /openapi.json, /swagger.json, /api/openapi.json, or /v1/openapi.json - MCP server card✗
/.well-known/mcp/server-card.json - OAuth protected resource✗
/.well-known/oauth-protected-resource - Agent card✗
/.well-known/agent-card.json - Agent skills✗
/.well-known/agent-skills/index.json
Publish these signals → /publishing