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
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}