Jump to Content
Home
What's New
Docs
Recipes
API Reference
What's New
v1.0.20250508
Home
What's New
API Reference
v1.0.20250508
Docs
Recipes
API Reference
What's New
Get a position by its code.
Search
All
Pages
Start typing to search…
JUMP TO
Greenshades API
Identity
Get information about the current security token
get
Workspaces
Get all authorized workspaces
get
Employees: Basic
Create a new employee
post
Get all employees by workspace Id.
get
Get an employee by Id.
get
Modify an existing employee.
put
Bulk create or update employees
post
Get an employee's contacts.
get
Get an employee's dependents.
get
Employees: Payroll Settings
Get an employee's direct deposit settings.
get
Update an employee's direct deposit settings. Overwrites any existing settings. Provide an empty list of accounts to clear all accounts.
put
Delete an employee's direct deposit settings. Clear all accounts.
delete
Get an employee's assigned earning codes.
get
Get setup information about a specific employee payroll tax
get
Save setup information about a specific employee payroll tax
put
Get an employee's assigned payroll pay schedule, if any.
get
Set an employee's assigned payroll pay schedule.
put
Remove an employee's payroll pay schedule assignment.
delete
Employees: Custom Fields
Create a new custom field.
post
Get all custom fields by workspace Id.
get
Get a custom field by its Id.
get
Modify an existing custom field.
put
Remove an existing custom field.
delete
Append or update an employee's custom field values.
patch
Get all custom fields for a given employee.
get
Employee Classes
Get all employee clases by workspace Id.
get
Create a new employee class.
post
Get an employee class by its code.
get
Modify an existing employee class.
put
Remove an existing employee class.
delete
Employee Settlements
Creates new employee settlements.
post
Departments
Get all departments by workspace Id.
get
Create a new department.
post
Get a department by its code.
get
Modify an existing department.
put
Remove an existing department.
delete
Positions
Get all positions by workspace Id.
get
Create a new position.
post
Get a position by its code.
get
Modify an existing position.
put
Remove an existing position.
delete
Get all worker compensation code mappings
get
Work Locations
Get all work locations by workspace Id.
get
Create a new work location.
post
Get a work location by its id.
get
Modify an existing work location.
put
Remove an existing work location.
delete
Payroll: Setup
Get all earnings by workspace Id.
get
Create a new earning.
post
Get an earning by its code.
get
Modify an existing earning.
put
Remove an existing earning.
delete
Get all pay schedules by workspace Id.
get
Get a pay schedule by its id.
get
Get all employees assigned to the given pay schedule.
get
Get information about taxes
get
Payroll: Pay Runs
Get all pay runs by workspace Id.
get
Get a pay run by its id.
get
Cancel a pay run.
delete
Get information about all employees included in a pay run.
get
Add an employee to a pay run.
post
Get information about an employee included in a pay run.
get
Modify information about an employee included in a pay run.
put
Remove an employee from a pay run.
delete
Add employees to a pay run.
post
Remove employees from a pay run.
post
Get all pay run earnings in a given pay run.
get
Create new pay run earnings.
post
Update existing pay run earnings.
put
Get a pay run earning by its id.
get
Remove an existing pay run earning.
delete
Payroll: Reports
Build a cost report based on a single pay run
get
Build a cost report based on a date range
get
Get all employee time off balances for a workspace.
get
Logs
Get all requests within date range.
get
Get the request given the Id
get
Web Hooks
Create a webhook event subscription.
post
Get all webhook event subscriptions by workspace Id.
get
Get one webhook event subscriptions by its id
get
Update a webhook event subscription.
put
Remove a webhook event subscription.
delete
Test a webhook subscription event
post
Employee Benefits
Get an employee's benefit elections
get
Employee Placements
Get the list of employee placements for a given workspace.
get
Retrieve placement data for a single placement.
get
Modify an existing placement.
put
Create a new placement.
post
Delete a single placement.
delete
Update or create a list of employee placements. Existing placements are overwritten, and new placements are created.
post
Delete all placements in a workspace.
delete
Pay History
Get pay record information by employee id.
get
Get pay record information by pay run id.
get
Get pay record information by workspace id.
get
Get a reference link providing one-use authorization to a pay record.
get
Get a pay document using an authorization code.
get
Employees: Payroll
Get all time off balances for an employee.
get
Get a position by its code.
get
https://api.greenshadesonline.com/positions/
{positionCode}
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!