Oyster API

REST discovered

Details

URL: https://api.oysterhr.com
Docs: https://docs.oysterhr.com/reference

Authentication

Oyster Developer Application (client ID + client secret) oauth2 discovered Set up OAuth ↗

Authorization: Bearer <credential>

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.

Oyster Developer Application (client ID + client secret) Authorization: Bearer <credential> + Oyster administrator actor email X-Oyster-Actor-Email: <credential> discovered

Oyster administrator actor email compound

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.