Jump to Content
Guides
Recipes
API Reference
Changelog
v2025-02-11
v2025-02-20
v2025-03-11
v2025-05-13
v2025-06-10
v2025-07-15
v2025-08-12
v2025-09-09
v2025-10-14
v2025-11-11
v2025-12-09
v2025-12-16
v2026-01-13
Login
API Reference
Login
v2025-06-10
Guides
Recipes
API Reference
Changelog
Onboarding Overview
All
Pages
Start typing to search…
JUMP TO
API Basics
Authentication
Errors
Filtering
Rate Limits
API Versioning
Webhooks
New Hire Webhooks
Employee Change Webhooks
Termination Webhooks
Payroll Processed Webhooks
Time Off Approval Webhooks
Future Dated Changes
Postman Collection
Assessments API
Assessments Overview
Callback
Upsert Callback
put
Get Callback
get
Delete Callback
del
Order
Update Assessment Order
patch
Package
Get Assessment Packages
get
Upsert Assessment Package
put
Upsert Assessment Packages [Batch]
put
Delete Assessment Package
del
Subscription
Upsert Subscription
put
Client Onboarding
Background Check API
Background Check Overview
Client Onboarding
Upsert Onboarding Status
post
Add Billing Codes
post
Get Company Billing Codes
get
Get client onboardings
get
Update Billing Code Status
patch
Delete Billing Code
del
[DEPRECATED] Updates Billing Code Status
patch
[DEPRECATED] Delete Billing Code
del
Subscription
Create Webhook for Candidate Screening Order
post
Get Webhook for Candidate Screening Order
get
Delete Webhook for Candidate Screening Order
del
Screening Package
Upsert Screening Package
post
Upsert Screening Packages [Batch]
post
Get Screening Packages
get
Delete Screening Package
del
Candidate Screening Order
Update Screening Order Status
patch
Company Level Information
Company Information
Get Company Information
get
Payroll/HR
Get Deduction Codes
get
Get Earning Codes
get
Get Pay Frequency Codes
get
Get Pay Grades
get
Get Position Codes
get
Get Rate Codes
get
Get Tax Codes
get
Get Work Locations
get
Get Workers Compensation Codes
get
Cost Centers
Get Cost Center Codes
get
Upsert Cost Center Code
put
Job Codes
Job Code API Overview
Create Job Code
post
Get Job Code [Single]
get
Get Job Codes [Batch]
get
Update Job Code
put
Delete Job Code
del
Filtering Job Codes
Document Management API
Documents Overview
Documents
Get a list of documents for a company
get
Get a list of documents filtered by employee for a company
get
Retrieve a document download URL
post
Employee Demographic API
Employees
Get Employees [Batch]
get
Get Employee [Single]
get
Learning Management API
LMS API Overview
Training Content
Create Training Content
post
Get Training Content [Single]
get
Get Training Content [Batch]
get
Partner Onboarding API
Onboarding Overview
Client Onboarding
Get Onboarding Status
get
Upsert Onboarding Status
put
Pay Entry
Pay Entry
Create New Payroll Batch
post
[DEPRECATED] Create New Payroll Batch
post
Pay Setup API
Pay Setup Overview
Recurring Deductions
Create Employee Deduction
post
Get Employee Deductions [Batch]
get
Get Employee Deduction [Single]
get
Get Employee Deduction by resourceId
get
Update Employee Deduction by resourceId
put
DELETE Recurring Deduction Code on the Employee Record“ to “Delete Employee Deduction by resourceId
del
Filtering Deductions
Recurring Earnings
Create Employee Earning [Single]
post
Get Employee Earnings [Batch]
get
Get Employee Earning [Single]
get
Get Employee Earning by resourceId
get
Update Employee Earning by resourceId
put
Delete Employee Earning by resourceId
del
Filtering Earnings
Punch detail Api
Punch Details Overview
Company Punch Details
Create Company Punch Detail Operation
post
Employee Punch Details
Gets Employee Punch Details
get
[DEPRECATED] Gets Employee Punch Details
get
Punch Import API
Punch Import Overview
Punch Import Data Fields
Punch Import
Create Employee Punch [Batch]
post
Scheduling Api
Employee Shifts
Get Employee Shifts
get
Company Shifts
Get Shifts by Company
get
Open Shifts
Get Open Shifts by Company
get
WebLink API
Authentication
Rate Limits
Deduction
Add / Update Deduction
post
Delete deduction for deduction code / start date
del
Get All Deductions
get
Get Deduction for Deduction Code
get
Onboarding
Add Employee to Onboarding
post
Additional Rates
Add/update additional rates
put
Client Credentials
Obtain new client secret.
post
Company Codes
Get All Company Codes
get
Company-Specific Schema
Get Company-Specific Open API Documentation
get
Custom Fields
Get All Custom Fields
get
Direct Deposit
Get All Direct Deposit
get
Earnings
Get All Earnings
get
Add/Update Earning
put
Get Earning by Earning Code and Start Date
get
Delete Earning by Earning Code and Start Date
del
Get Earnings by Earning Code
get
Emergency Contacts
Add/update emergency contacts
put
Employee Benefit Setup
Add/update employee's benefit setup
put
Employee Staging
Add new employee to Web Link
post
Employee
Get all employees
get
Add new employee
post
Get employee
get
Update employee
patch
Local Taxes
Get all local taxes
get
Update Local Tax
put
Add new local tax
post
Get local taxes by tax code
get
Delete local tax by tax code
del
Non-Primary State Tax
Add/update non-primary state tax
put
Pay Rate Searches
Create an employee pay rates search
post
PayStatements
Get employee pay statement details data for the specified year and check date.
get
Get employee pay statement details data for the specified year.
get
Get employee pay statement summary data for the specified year and check date.
get
Get employee pay statement summary data for the specified year.
get
Primary State Tax
Add/update primary state tax
put
Sensitive Data
Get sensitive data
get
Add/update sensitive data
put
Status Searches
Create an employee statuses search
post
Powered by
Onboarding Overview
Used to onboard companies to a partner exclusive API
