For AI agents: visit https://apidocs.worklio.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Log In

API Reference

Log In

Guides API Reference Changelog

Current User
Capabilities
- Lists capability codes that are enabled for the current Worklio instance.get
- Lists the effective capabilities available to the current user in the specified company.get
Admin Logins
- Generates a back-office SSO link for another user's highest eligible admin or system role.get

Middesk_v10
- MiddeskWebhook.post
Company Basic
Employee Requests
- Request Policyget
- Save Request Policypost
Company Help and Support Contacts
- Lists help and support contacts available for the specified company.get
- Lists the help and support contact categories configured for the company.get
Company Tax Setup
- Get Current Tax Setupget
- Update Tax Setup Valuespost
Company Signatories
Company Bank Accounts
Company Documents - Signatures
Company Divisions
- Lists divisions for the specified company.get
Company Positions
Company Documents
- Gets metadata for the company root folder or a specific company document subfolder.get
- Gets the immediate child folders and documents stored in a company document folder.get
Employee Documents
EWA Integration
Affix
Banking
Bank Setup
- Get Bank Setup Statusget
- Get Bank Onboarding Obsoleteget
Bulletin
- Lists bulletin messages visible for the current caller in the specified company.get
- Adds or removes bulletin message status flags for the current caller.put
Client Emp. Management Tools
- Lists HR integrations available for the specified company.get
Estimated Annual Wage
- Get Estimated Annual Wagepost
- Get Estimated Annual Wagepost
Calendar
E-Verify Cases
- Lists E-Verify cases for the specified company.get
E-Verify Setup
Helpful Links
HR Fields Setup
ID Collection
- Lists supported identity document collection types.get
Kotapay
KYC
Net Promoter Score
Company Organization Structure
Pulse Surveys
Team

Company Work Location
Company Departments
Company Divisions

Employees
Employee Tax Setup
- Get Current Tax Setupget
- Update Tax Setup Valuespost
EWA Integration
- Get list of Employees for the EWAget
- Get EWA Widget for Employeeget
Terms
Employee Form1099
Employee W-2
HR Fields Data
ID Collection
Employees Working Hours
- Gets the employee's scheduled working time for the current day.get
Requests
Employee Bank Accounts

Setup
- Returns the onboarding templates that can be used for the company.get
- Creates a new onboarding and returns the initial setup workflow metadata.post
Phase: 1) Settings
Phase: 2) Onboarding New Hire
- Returns employee-facing HR custom fields for phase 2 onboarding.get
- Saves employee-provided HR custom field values for phase 2 onboarding.put
Phase: 2) Onboarding New Hire - Overview
- Returns the employee HR-field answers for employer-side review.get
Phase: 3) Verification
Overview
Finalize_v10
- Assigns a manager to the onboarding before finalization completes.put

Payroll Policies
Payroll Basic
Void Payroll
Employee Payroll
Earning Codes
Pay Allocations
Employee Status
- Employee status for payrollpost
- Employee validity for payrollpost
Payroll Advanced
Payroll Information & History
Timesheet
Termination Payroll
Payroll Gross-Up
Payroll Checks
Payroll Messages
- Get a list of payroll paylines messagesget
- Get a list of payline messagesget
Company Pay Codes
- Returns client pay codes for a specific company.get
Unblock Payroll
- Unblock Payrollpost

Onboarding
YTD Payroll Setup

Company Benefits
Employee Benefits
Employee Deductions
Company Benefits Groups

Dashboard

Job and Project Costing
Reports

Workers' Compensation

TimeOff Policy - Company
TimeOff Groups - Company
- Get list of TimeOff Policiesget
TimeOff Policy - Employee Transactions
TimeOff Policy - Employee

Employee TimeOff Requests
Employee TimeOff Request
Company TimeOff Requests
Company TimeOff Request
Company TimeOff Request Types
Company TimeOff Request Type
Company TimeOff Request Setup

Admin Logins
Multi Admin Logins
Address Validation
- Address Validationpost
Registrations
- Get list of new user and company registrations and their current status.get
- Get detailed info about new user and companies registration and current status.get
White-Labeling & Brands
Company Access Policy
- Gets the effective employee application access policy for the company.get
- Updates the employee application access policy for the company.post
General
Employees Access
Files
Notifications
Support Chat Info
- Get Support Chat Infoget
- Get Support Chat Infoget
Web Hooks
List of Fees
- List of fees configurations for a all clients.get
List of Fee Configurations
- List of fees configurations for a specific client.get
List of All Billing History
- List of billing history for all clients.get
List of Billing History
- List of billing history for a specific client.get

Employee Benefits And Deductions
Benefits Enrollment
Employees Event Life Requests
Company Benefits
Employee Benefits
Employee Deductions
Company Benefits Groups
- List of Benefit Groupsget

Employee's Policy
- Get timeoff request employee's policyget
- Update timeoff request employee's policyput
TimeOff Requests Policies
- Get list of timeoff request policiesget
- Update timeoff request policypatch
TimeOff Requests
TimeOff Requests Types

Workers' Compensation

Onboarding
- Gets whether prior payroll history import is completed for the company onboarding flow.get
YTD Payroll Setup

Create
- Lists employees for whom a new W-4 request can be created.get
- Creates a new W-4 request for an employee.post
Overview
Verification

ClientGL Export Connectors
ClientGL Simplified Mapping
ClientGL Exports
OAuth endpoints
- This endpoint is used to receive authorization tokens from QuickBooks Online and other third-party apps.get
ClientGL Payrolls
- Gets list of payrolls for given criteria.get

Overview
Time Clock
Missing Breaks
Approving
- Gets attestation messages for the employee approval period.get
- Approves or disapproves reported time for a date range.post
Change Log
Notes
Timesheet

Powered by

Benefits & Deductions API

Employee Deductions

Updated 12 months ago

Unblock Payroll

Company Benefits Groups

Did this page help you?

Updated 12 months ago

Unblock Payroll

Company Benefits Groups

Did this page help you?