Guides

Worklio Admin iFrame API

📌 Prerequisites

Before calling the iFrame API, ensure the following:

  • ✅ You have an active Worklio Embedded Payroll or Worklio API Module.
  • ✅ You have a valid Bearer token generated using the/token API endpoint.

🚀 API Endpoint

POST /iframe
Use the POST method to generate an embeddable iFrame URL.

📦 Request Body

{
  "Email": "[email protected]",
  "WithMenu": false,
  "Page": 0,
  "RoleAccess": 1,
  "EntityId": 123,
  "Company": 123
}

🔍 Field Details

FieldTypeRequiredDescription
Emailstring✅ YesEmail address of the user
WithMenubool✅ Yestrue to include Worklio menu inside the iFrame
Pageint✅ YesEnum value representing the page to display (see full list below)
RoleAccessint✅ Yes1 = System Admin, 2 = Client Admin
EntityIdint❌ OptionalRequired for pages with routes containing {ClientId} or other IDs
Companyint❌ OptionalUsed for users linked to multiple companies (e.g., Dashboard)

📥 Sample Response

{
  "url": "https://api.worklio.com/DispatcherICU?scu=..."
}

Use the returned url in an <iframe> to display the embedded Worklio module.

📄 Full List of Page Enum Values

EnumPage NameAccessRoute
0DashboardSystem, Client Admin~/Dashboard
2ReportsSystem, Client Admin~/Reports, ~/Company/{ClientId}/Reports
9User Accounts SettingsSystem Admin~/Settings/General/UserAccounts
10SettingsSystem Admin~/Settings
11ClientsSystem Admin~/Clients
12Company InfoSystem, Client Admin~/Company/{ClientId}/CompanyInfo
13Company ContactsSystem, Client Admin~/Company/{ClientId}/Contacts
14Support ContactsSystem, Client Admin~/Company/{ClientId}/SupportContacts
15Helpful LinksSystem, Client Admin~/Company/{ClientId}/UrlLinks
16Bulletin MessagesSystem, Client Admin~/Company/{ClientId}/BulletinMessages
17DivisionsSystem, Client Admin~/Company/{ClientId}/Divisions
18Client GroupsSystem, Client Admin~/Company/{ClientId}/ClientGroups
19KYC VerificationSystem, Client Admin~/Company/{ClientId}/KYC
20Payroll OverviewSystem, Client Admin~/Payroll, ~/Company/{ClientId}/Payroll
21Payroll HistorySystem, Client Admin~/Payroll/History, ~/Company/{ClientId}/Payroll/History
22Employees OverviewSystem, Client Admin~/Company/{ClientId}/Employees
23Employee OnboardingSystem, Client Admin~/Company/{ClientId}/Onboarding
24Org StructureSystem, Client Admin~/Company/{ClientId}/OrganizationStructureOverview
25Benefits Enrollment (Individual)System, Client Admin~/Company/{ClientId}/BE/Enrollment
26I-9 FormsSystem, Client Admin~/Company/{ClientId}/Employees/I9
27HR TrackingSystem, Client Admin~/Clients/HRTrackingEvents, ~/Company/{ClientId}/Employees/HRTrackingEvents
28Employee RequestsSystem, Client Admin~/Employees/Requests, ~/Company/{ClientId}/Employees/Requests
29E-Verify CasesSystem, Client Admin~/Company/{ClientId}/EVerify
30GL ExportSystem, Client Admin~/Company/{ClientId}/GLExport
31Analytics (Previous)System, Client Admin~/Analytics, ~/Company/{ClientId}/Analytics
32Settings OverviewSystem, Client Admin~/Company/{ClientId}/Settings
33Company User AccountsSystem, Client Admin~/Company/{ClientId}/Settings/UserAccounts
34DepartmentsSystem, Client Admin~/Company/{ClientId}/Departments
35WorklocationsSystem, Client Admin~/Company/{ClientId}/Worklocations
36PositionsSystem, Client Admin~/Company/{ClientId}/Settings/Positions
37Distribution CodesSystem, Client Admin~/Company/{ClientId}/DistributionCodes
38Holiday ScheduleSystem, Client Admin~/Company/{ClientId}/Settings/HolidaySchedule
39Org Structure (Settings)System, Client Admin~/Company/{ClientId}/OrganizationStructure
40E-Verify (Settings)System, Client Admin~/Company/{ClientId}/Settings/EVerify
41Deduction CodesSystem, Client Admin~/Company/{ClientId}/Settings/Deductions/DeductionCodes
42Benefit GroupsSystem, Client Admin~/Company/{ClientId}/Settings/Deductions/BenefitGroups
43Benefit PlansSystem, Client Admin~/Company/{ClientId}/Settings/Deductions/Benefits/Plans
44Contribution RulesSystem, Client Admin~/Company/{ClientId}/Settings/Deductions/ContributionRules
45Benefit RulesSystem, Client Admin~/Company/{ClientId}/Settings/Deductions/BenefitRules
46Bank AccountsSystem, Client Admin~/Company/{ClientId}/Settings/Banking/BankAccounts
47Bank Provider ApprovalSystem, Client Admin~/Company/{ClientId}/Settings/Banking/BankProviderApproval
48Onboarding PagesSystem, Client Admin~/Company/{ClientId}/Settings/Onboarding/Pages
49Onboarding EmailsSystem, Client Admin~/Company/{ClientId}/Settings/Onboarding/Emails
50Template DocumentsSystem, Client Admin~/Company/{ClientId}/Settings/Onboarding/Documents
51Onboarding TemplatesSystem, Client Admin~/Company/{ClientId}/Settings/Onboarding/Templates
52GL Invoice Adj. CodesSystem, Client Admin~/Company/{ClientId}/Settings/GeneralLedger/InvoiceAdjCodes
53GL ConfigurationSystem, Client Admin~/Company/{ClientId}/Settings/GeneralLedger/ClientGLConfiguration
54Public DocumentsSystem, Client Admin~/Folders, ~/Company/{ClientId}/Folders
55Client DocumentsSystem, Client Admin~/Folders/{id}, ~/Company/{ClientId}/Folders/{id}
56Client General (Settings)System, Client Admin~/Company/{ClientId}/Settings/Company/General
57Client Vendors (Settings)System, Client Admin~/Company/{ClientId}/Vendors
58Client Payroll Paycodes (Settings)System, Client Admin~/Company/{ClientId}/Settings/Payroll/PayCodes
59Client Payroll Rules (Settings)System, Client Admin~/Company/{ClientId}/Settings/Payroll/PayrollRules
60Client Payroll Tax Setup (Settings)System, Client Admin~/Company/{clientId}/Settings/Payroll/TaxSetup/{id?}
61Client Deduction Codes (Settings)System, Client Admin~/Company/{ClientId}/Settings/Deductions/DeductionCodes
62Client Benefit Groups (Settings)System, Client Admin~/Company/{ClientId}/Settings/Deductions/BenefitGroups
63Client Benefit Plans (Settings)System, Client Admin~/Company/{ClientId}/Settings/Deductions/Benefits/Plans
64Client Contribution Rules (Settings)System, Client Admin~/Company/{clientID}/Settings/Deductions/ContributionRules
65Client Benefit Rules (Settings)System, Client Admin~/Company/{ClientId}/Settings/Deductions/BenefitRules
66Client Bank Accounts (Settings)System, Client Admin~/Company/{clientId}/Settings/Banking/BankAccounts
67Client SUTA Rates (Settings)System, Client Admin~/Company/{ClientId}/Settings/Billing/SUTA
68Client Workers' Compensation Client Rate Tables (Settings)System, Client Admin~/Company/{clientId}/Settings/WC/RateTables
69Client Workers' Compensation Rules (Settings)System, Client Admin~/Company/{ClientId}/Settings/WC/Rules
70Client Time Off Groups (Settings)System, Client Admin~/Company/{ClientId}/Settings/TimeOff/Groups
71Client Time Off Rules (Settings)System, Client Admin~/Company/{ClientId}/Settings/TimeOff/Rules
72Client Tax Reporting Entities (Settings)System, Client Admin~/Company/{ClientId}/Settings/Payroll/TaxEntities
73Client GL Accounts (Settings)System, Client Admin~/Company/{ClientId}/Settings/GeneralLedger/ClientGLAccounts
74Client GL Export Format and Data (Settings)System, Client Admin~/Company/{ClientId}/Settings/GeneralLedger/ClientGLExportSettings/Detail
75Client Rate Tables (Settings))System, Client Admin~/Company/{clientId}/Settings/Payroll/RateTables
76Client Qualifying Life Events (Settings)System, Client Admin~/Company/{ClientId}/Settings/EBR/QualifyingLifeEvents
77Client Certified Class Codes (Settings)System, Client Admin~/Company/{clientId}/Settings/Payroll/CertifiedClassCodes
78Client Unions (Settings)System, Client Admin~/Company/{clientId}/Settings/Payroll/Unions/Unions
79Client Union Locals (Settings)System, Client Admin~/Company/{clientId}/Settings/Payroll/Unions/UnionLocals
80Client Union Class Codes (Settings))System, Client Admin~/Company/{clientId}/Settings/Payroll/Unions/UnionClassCodes
81Client Union Package Items (Settings)System, Client Admin~/Company/{clientId}/Settings/Payroll/Unions/UnionPackageItems
82Client Job Costing (Settings)System, Client Admin~/Company/{ClientId}/Settings/JobCosting/{Id?}
83Client JobsSystem, Client Admin~/Company/{clientId}/Jobs
84Client Certified Projects (Settings)System, Client Admin~/Company/{clientId}/Settings/Client/CertifiedProjects
85Client Job Costing WC Mappings (Settings)System, Client Admin~/Company/{clientId}/Settings/Client/JobCosting/WCMappings
86Client TOR RequestsSystem, Client Admin~/Company/{clientId}/TOR/Requests
87Client TOR Requests (Settings)System, Client Admin~/Company/{clientId}/Settings/TOR
88Client Bulk EnrollmentSystem, Client Admin~/Company/{clientId}/BE/BulkEnrollment
89Client TA Rules (Settings))System, Client Admin~/Company/{ClientId}/Settings/TA/Rules
90Client TA Calculation Rules (Settings)System, Client Admin~/Company/{clientId}/Settings/TA/CalcRules
91Client TA Workweeks (Settings))System, Client Admin~/Company/{clientId}/Settings/TA/Workweeks
92Client OnboardingSystem, Client Admin~/Clients/Onboarding
93Client Tracking Templates (Settings)System, Client Admin~/Company/{clientId}/Settings/TrackingTemplates
94Client Custom HR FieldsSystem, Client Admin~/Company/{clientId}/Employees/HRFields
95Client Apprenticeship Programs (Settings)System, Client Admin~/Company/{clientId}/Settings/Payroll/ApprenticeshipPrograms
96Client Awarding Bodies (Settings)System, Client Admin~/Company/{clientId}/Settings/Client/AwardingBodies
97Client Certified Fringe Benefits (Settings)System, Client Admin~/Company/{clientId}/Settings/Payroll/FringeBenefits
98Client Fringe Benefit Packages (Settings)System, Client Admin~/Company/{clientId}/Settings/Payroll/FringeBenefitPrograms
99Client W4 RequestsSystem, Client Admin~/Company/{clientId}/W4Requests
100Payroll - Process Payments - Online TransactionsSystem, Client Admin~/Payroll/ProcessPayments/OnlineTransactions
101Payroll - Process Payments - Nacha FilesSystem, Client Admin~/Payroll/ProcessPayments/NACHA
102Payroll - Process Payments -Unapplied TransactionsSystem, Client Admin~/Payroll/ProcessPayments/UnappliedTransactions
103Payroll - Process Payments - Positive PaySystem, Client Admin~/Payroll/ProcessPayments/PositivePay
104Payroll - Process Payments - Vendor ChecksSystem, Client Admin~/Payroll/ProcessPayments/VendorChecks
105Payroll - Process Payments - Transactions for ApproveSystem, Client Admin~/Payroll/ProcessPayments/TransactionsForApprove
106Payroll - Process Payments - Child Support Payment FilesSystem, Client Admin~/Payroll/ProcessPayments/ChildSupportPaymentFiles
107Payroll - Process Payments - Employee Checks HistorySystem, Client Admin~/Payroll/ProcessPayments/EmployeeChecksHistory
108Payroll - Exports - Master Tax Monthly WageSystem, Client Admin~/Payroll/Export/MasterTax/Monthly
109Payroll - Exports - Master Tax Payroll Tax Export PTSSystem, Client Admin~/Payroll/Export/MasterTax/PTS
110Payroll - Exports - Master Tax Reconciliation Tax RTSSystem, Client Admin~/Payroll/Export/MasterTax/RTS
111Payroll - Exports - Asure SetupSystem, Client Admin~/Payroll/Export/Asure/Setup
112Payroll - Exports - Asure PTSSystem, Client Admin~/Payroll/Export/Asure/PTS
113Payroll - Exports - Asure RTSSystem, Client Admin~/Payroll/Export/Asure/RTS
114Reports - Audits Payroll - Audit LogSystem, Client Admin~/Analytics/Audits/PaRun
115Reports - Audits - Master Audit LogSystem, Client Admin~/Analytics/Audits/Master
116Reports - Audits - Client Audit LogSystem, Client Admin~/Analytics/Audits/Client
117Reports - Audits - Employee Audit LogSystem, Client Admin~/Analytics/Audits/Employee
118Reports - Audits - Report QueueSystem, Client Admin~/Analytics/Audits/ReportQueue
119Reports - New Hire Report - Generated FilesSystem, Client Admin~/Analytics/HR/NewHireReportFiles
120Reports - New Hire Report - Employee ListSystem, Client Admin~/Analytics/HR/NewHireReportEmployees
121Reports - Tax Filing - W2 FormsSystem, Client Admin~/Analytics/W2
122Reports - Tax Filing - W2 AlertsSystem, Client Admin~/Analytics/W2/Alerts
123Reports - Tax Filing - W2 Filing FederalSystem, Client Admin~/Analytics/FederalW2Filling
124Reports - Tax Filing - W2 Filing SolvSystem, Client Admin~/Analytics/SolvW2Filling
125Reports - Tax Filing - W2 Filing StateSystem, Client Admin~/Analytics/StateW2Filling
126Reports - Tax Filing - 940 FormSystem, Client Admin~/Analytics/F940
127Reports - Tax Filing - 941 FormSystem, Client Admin~/Analytics/F941
128Reports - Tax Filing - 943 FormSystem, Client Admin~/Analytics/F943
129Reports - Tax Filing - 1099 NEC FormsSystem, Client Admin~/Analytics/Form1099/NEC
130Reports - Tax Filing - 1099 NEC Filing FederalSystem, Client Admin~/Analytics/Form1099/NEC/EFilling/Federal
131Reports - Tax Filing - 1099 NEC Filing SolvSystem, Client Admin~/Analytics/Form1099/NEC/SolvFilling
132Reports - Tax Filing - SUTA FilingSystem, Client Admin~/Analytics/SUTAFilling
133Reports - Tax Filing - LIT FilingSystem, Client Admin~/Analytics/LITFiling
134Reports - Tax Filing - IL941SSystem, Client Admin~/Analytics/IL941S
135Reports - ACA Reporting - MonthsSystem, Client Admin~/Analytics/ACA/Months
136Reports - ACA Reporting - EntitiesSystem, Client Admin~/Analytics/ACA/Entities
137Reports - ACA Reporting - Reports Client SummarySystem, Client Admin~/Analytics/ACA/Reports/ClientSummary
138Reports - ACA Reporting - Reports - ALE WorksheetSystem, Client Admin~/Analytics/ACA/Reports/AleWorksheet
139Reports - ACA Reporting - Reports - Employee Lookback StatusSystem, Client Admin~/Analytics/ACA/Reports/Summary
140Reports - ACA Reporting - Reports VerificationSystem, Client Admin~/Analytics/ACA/Reports/Verification
141Reports - ACA Reporting - Reports 1095cSystem, Client Admin~/Analytics/ACA/Reports/1095c
142Reports - ACA Reporting - Reports 1094cSystem, Client Admin~/Analytics/ACA/Reports/1094c
143Reports - ACA Reporting - Reports 1095bSystem, Client Admin~/Analytics/ACA/Reports/1095b
144Reports - ACA Reporting - Reports 1094bSystem, Client Admin~/Analytics/ACA/Reports/1094b
145Reports - ACA Reporting - Reports 1095c SolvSystem, Client Admin~/Analytics/ACA/Reports/SOLV
146Reports - ACA Reporting - Reports - TransmissionsSystem, Client Admin~/Analytics/ACA/Transmissions

Updated 18 days ago