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

Field	Type	Required	Description
`Email`	string	✅ Yes	Email address of the user
`WithMenu`	bool	✅ Yes	`true` to include Worklio menu inside the iFrame
`Page`	int	✅ Yes	Enum value representing the page to display (see full list below)
`RoleAccess`	int	✅ Yes	`1` = System Admin, `2` = Client Admin
`EntityId`	int	❌ Optional	Required for pages with routes containing `{ClientId}` or other IDs
`Company`	int	❌ Optional	Used 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

Enum	Page Name	Access	Route
0	Dashboard	System, Client Admin	`~/Dashboard`
2	Reports	System, Client Admin	`~/Reports`, `~/Company/{ClientId}/Reports`
9	User Accounts Settings	System Admin	`~/Settings/General/UserAccounts`
12	Company Info	System, Client Admin	`~/Company/{ClientId}/CompanyInfo`
13	Company Contacts	System, Client Admin	`~/Company/{ClientId}/Contacts`
14	Support Contacts	System, Client Admin	`~/Company/{ClientId}/SupportContacts`
15	Helpful Links	System, Client Admin	`~/Company/{ClientId}/UrlLinks`
16	Bulletin Messages	System, Client Admin	`~/Company/{ClientId}/BulletinMessages`
17	Divisions	System, Client Admin	`~/Company/{ClientId}/Divisions`
18	Client Groups	System, Client Admin	`~/Company/{ClientId}/ClientGroups`
19	KYC Verification	System, Client Admin	`~/Company/{ClientId}/KYC`
20	Payroll Overview	System, Client Admin	`~/Payroll`, `~/Company/{ClientId}/Payroll`
21	Payroll History	System, Client Admin	`~/Payroll/History`, `~/Company/{ClientId}/Payroll/History`
22	Employees Overview	System, Client Admin	`~/Company/{ClientId}/Employees`
23	Employee Onboarding	System, Client Admin	`~/Company/{ClientId}/Onboarding`
24	Org Structure	System, Client Admin	`~/Company/{ClientId}/OrganizationStructureOverview`
25	Benefits Enrollment (Individual)	System, Client Admin	`~/Company/{ClientId}/BE/Enrollment`
26	I-9 Forms	System, Client Admin	`~/Company/{ClientId}/Employees/I9`
27	HR Tracking	System, Client Admin	`~/Clients/HRTrackingEvents`, `~/Company/{ClientId}/Employees/HRTrackingEvents`
28	Employee Requests	System, Client Admin	`~/Employees/Requests`, `~/Company/{ClientId}/Employees/Requests`
29	E-Verify Cases	System, Client Admin	`~/Company/{ClientId}/EVerify`
30	GL Export	System, Client Admin	`~/Company/{ClientId}/GLExport`
31	Analytics (Previous)	System, Client Admin	`~/Analytics`, `~/Company/{ClientId}/Analytics`
32	Settings Overview	System, Client Admin	`~/Company/{ClientId}/Settings`
33	Company User Accounts	System, Client Admin	`~/Company/{ClientId}/Settings/UserAccounts`
34	Departments	System, Client Admin	`~/Company/{ClientId}/Departments`
35	Worklocations	System, Client Admin	`~/Company/{ClientId}/Worklocations`
36	Positions	System, Client Admin	`~/Company/{ClientId}/Settings/Positions`
37	Distribution Codes	System, Client Admin	`~/Company/{ClientId}/DistributionCodes`
38	Holiday Schedule	System, Client Admin	`~/Company/{ClientId}/Settings/HolidaySchedule`
39	Org Structure (Settings)	System, Client Admin	`~/Company/{ClientId}/OrganizationStructure`
40	E-Verify (Settings)	System, Client Admin	`~/Company/{ClientId}/Settings/EVerify`
41	Deduction Codes	System, Client Admin	`~/Company/{ClientId}/Settings/Deductions/DeductionCodes`
42	Benefit Groups	System, Client Admin	`~/Company/{ClientId}/Settings/Deductions/BenefitGroups`
43	Benefit Plans	System, Client Admin	`~/Company/{ClientId}/Settings/Deductions/Benefits/Plans`
44	Contribution Rules	System, Client Admin	`~/Company/{ClientId}/Settings/Deductions/ContributionRules`
45	Benefit Rules	System, Client Admin	`~/Company/{ClientId}/Settings/Deductions/BenefitRules`
46	Bank Accounts	System, Client Admin	`~/Company/{ClientId}/Settings/Banking/BankAccounts`
47	Bank Provider Approval	System, Client Admin	`~/Company/{ClientId}/Settings/Banking/BankProviderApproval`
48	Onboarding Pages	System, Client Admin	`~/Company/{ClientId}/Settings/Onboarding/Pages`
49	Onboarding Emails	System, Client Admin	`~/Company/{ClientId}/Settings/Onboarding/Emails`
50	Template Documents	System, Client Admin	`~/Company/{ClientId}/Settings/Onboarding/Documents`
51	Onboarding Templates	System, Client Admin	`~/Company/{ClientId}/Settings/Onboarding/Templates`
52	GL Invoice Adj. Codes	System, Client Admin	`~/Company/{ClientId}/Settings/GeneralLedger/InvoiceAdjCodes`
53	GL Configuration	System, Client Admin	`~/Company/{ClientId}/Settings/GeneralLedger/ClientGLConfiguration`
54	Public Documents	System, Client Admin	`~/Folders`, `~/Company/{ClientId}/Folders`
55	Client Documents	System, Client Admin	`~/Folders/{id}`, `~/Company/{ClientId}/Folders/{id}`

Updated 28 days ago