Jump to Content

Guides API Reference

v1.0

API Reference

v1.0Guides API Reference

All

Pages

Start typing to search…

User API

Current User
Capabilities
- Get list of capabilitiesget
- Get list of user capabilitiesget
Admin Logins
- Retrieves link to back-office for SSO on-behalf-of userget

Company API

Middesk_v10
- MiddeskWebhook.post
Company Basic
Employee Requests
- Request Policyget
- Save Request Policypost
Company Help and Support Contacts
- Get list of company Help and Support contacts for employeesget
- Get list of company Help and Support Typesget
Company Tax Setup
- Get Current Tax Setupget
- Update Tax Setup Valuespost
Company Signatories
Company Bank Accounts
Company Documents - Signatures
Company Divisions
- Get list of Company Divisionget
Company Positions
Company Documents
- Get info about client folderget
- /wep/companies/{companyId}/folders/{folderId}/itemsget
Employee Documents
EWA Integration
Affix
Banking
Bank Setup
- Get Bank Setup Statusget
- Get Bank Onboarding Obsoleteget
Bulletin
- List of Bulletin Messagesget
- Set Status for Bulletin Messagesput
Client Emp. Management Tools
- /wep/companies/{companyId}/integrations/hrget
Estimated Annual Wage
- Get Estimated Annual Wagepost
- Get Estimated Annual Wagepost
Calendar
- Calendar Events - get all events for the company.get
- Event Typesget
E-Verify Cases
- List Of Casesget
E-Verify Setup
Helpful Links
HR Fields Setup
ID Collection
- Get List of ID collection typesget
Kotapay
KYC
Net Promoter Score
Company Organization Structure
Pulse Surveys

Company Structure API

Company Work Location
Company Departments
Company Divisions

Employee API

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
Requests
Employees Working Hours
- Employee's Working Timeget

Employee Self-Onboarding API

Setup
- Returns list of templatesget
- Start new employee onboardingpost
Phase: 1) Settings
Phase: 2) Onboarding New Hire
- Get HR Fieldsget
- Save HR Fieldsput
Phase: 2) Onboarding New Hire - Overview
- Get HR Fieldsget
Phase: 3) Verification
Overview
Finalize_v10
- /wep/companies/{companyId}/onboarding/finalize/{id}/setup-manager/{managerId}put

Payroll API

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

YTD Import API

Onboarding
- Get payrollget
YTD Payroll Setup

Benefits & Deductions API

Company Benefits
Employee Benefits
Employee Deductions
Company Benefits Groups
- List of Benefit Groupsget

Dashboard API

Dashboard

Reports API

Job and Project Costing
Reports

Workers' Compensation API

Workers' Compensation

TimeOff API

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

TimeOff Requests API

Employee TimeOff Requests
- Get list of timeoff requestsget
Employee TimeOff Request
Company TimeOff Requests
- Get list of timeoff requestsget
Company TimeOff Request
Company TimeOff Request Types
- Get list of timeoff request typesget
Company TimeOff Request Type
Company TimeOff Request Setup

System API

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
- Get the access policy for the companyget
- Set the access policy for the companypost
General
Employees Access
Files
Notifications
Support Chat Info
- Get Support Chat Infoget
Web Hooks

Powered by

Get HR Fields

get

https://api.worklio.com/wep/companies/{companyId}/onboarding/overview/{id}/hr-fields

Language

Credentials

Bearer

jwt

Click Try It! to start a request and see the response here!