Thanks to visit codestin.com
Credit goes to docs.stackone.com

Skip to main content
Oyster HR
Oyster HR
52 actions · 1 auth method
PreviewHRIS

​
Authentication

OAuth 2.0

Connect using OAuth 2.0 by creating a Developer App in the Oyster Developer Portal.Guides: Connector Profile, Link Account
Actions
52 actions
Action
Description
Get Company
Retrieve company details for the authenticated organization
List Departments
Retrieve a paginated list of departments
List Engagements
Retrieve a paginated list of engagements (employees and contractors)
Get Engagement
Retrieve details of a specific engagement by ID
List Engagement Allowances
Retrieve a paginated list of allowances for a specific engagement
List Engagement Bonuses
Retrieve a paginated list of bonuses for a specific engagement
Update Personal Details
Update personal details for an employment
List Engagement Documents
Retrieve a paginated list of documents for a specific engagement
List Engagement Payslips
Retrieve a paginated list of payslips for a specific engagement
List Time Off Entitlements
Retrieve a paginated list of time off entitlements
Get Time Off Entitlement
Retrieve entitlements for an individual engagement
List Time Off Requests
Retrieve a paginated list of time off requests
Get Time Off Request
Retrieve an individual time off request by ID
Create Time Off Request
Create a new time off request for an engagement
Approve Time Off Request
Approve a pending time off request
Reject Time Off Request
Reject a pending time off request
List Expenses
Retrieve all expenses
Get Expense
Retrieve an individual expense by ID
Create Expense
Create a new expense record
Delete Expense
Delete an expense record by ID
Approve Expense
Approve a pending expense
Decline Expense
Decline a pending expense
List Payroll
Retrieve a paginated list of payroll entries
Get Payroll Item
Retrieve a single payroll entry by ID
List Payroll Records
Retrieve payroll records for an individual payroll
List Payroll Changes
Retrieve all payroll changes
Get Payroll Change
Retrieve a single payroll change by ID
Create Payroll Change
Create a payroll change for an engagement
Update Payroll Change
Update an existing payroll change
Cancel Payroll Change
Cancel a payroll change
Get Default Payroll Changes Source Types
Retrieve default payroll changes rulesets for source types
Get Default Payroll Changes Ruleset
Retrieve default payroll changes ruleset
Get Payroll Changes Source Types
Retrieve payroll changes rulesets for source types
Get Payroll Changes Ruleset
Retrieve payroll changes ruleset
List Bank Accounts
Retrieve bank accounts for the company
Get Bank Account
Retrieve bank account details by ID
List Time Sheets
Retrieve all time sheets for the company
Get Time Sheet
Retrieve an individual time sheet by ID
Create Time Sheet
Create a new time sheet for an engagement
Create Time Sheet Entry
Create a new entry in a time sheet
Submit Time Sheet
Submit a time sheet for approval
Confirm Time Sheet
Confirm a time sheet
Update Time Sheet Entry
Update an existing time sheet entry
Delete Time Sheet Entry
Delete a time sheet entry
Delete Time Sheet
Delete a time sheet
Create Hiring Employment
Create a new hiring employment record
Get Hiring Employment
Retrieve an individual hiring employment by ID
Submit Hiring Employment
Submit a hiring employment for processing
Invite Team Member
Send invitation to a team member for a hiring employment
Get Hiring Employment Tasks
Retrieve hiring process tasks for an employment
Update Hiring Employment
Update a draft hiring employment record
Delete Hiring Employment
Delete a draft hiring employment record

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/oyster/filled/png

Connector Profile

Oyster HR - OAuth 2.0
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/oyster/filled/png

Link Account

Oyster HR - OAuth 2.0
4

Use Actions

Invoke actions using one of the methods below: