The Oyster API lets you securely access data in your Oyster account and automate key workflows from third-party systems. With it, teams can integrate Oyster data and actions into internal tools, reporting, or custom applications without using the Oyster UI.
What you can do with the API
Some examples of things you can do with the API include:
- Sync team member records to your HRIS or data warehouse
- Automate lifecycle events like new hires, updates, or offboarding
- Retrieve employment details for reporting and analytics
- Build internal tools that surface Oyster information to your team
- Trigger workflows and reduce manual, repetitive tasks
We are constantly adding new functionalities to our API, so please review the documentation for a current list of API functionality.
Getting started
To use the API, your development team can review the API documentation at https://docs.oysterhr.com/. The documentation contains information about endpoints, authentication, examples and guides.
Support
- Implementation guides, endpoint references, and sample requests are available at https://docs.oysterhr.com
- If you need additional help, use the contact options listed in the documentation.