Tool reference
185 tools, organized by domain.
Every tool the production server advertises, in 31 sections. Required parameters come first; optional ones end in ?. Tools that change data are marked writes.
Last verified 2026-09-10 against the live server — every name below is checked against get_api_docs({ section: "matrix" }) on each build.
Workspace & Identity
Call these first: get_workspace confirms which workspace the key belongs to, get_me resolves the caller's own employeeRecordId before any employee-scoped tool.
ScopesNone — any workspace member
Tool
Description
Parameters
get_workspace
The workspace tied to your API key — id and name.
none
get_me
The user behind the key and their linked employeeRecordId. If it's null, find the record with list_employees.
none
Employee Management
Directory reads, record writes, and signup invites.
Scopesemployee:addemployee:manage-dataself:manage-data
Tool
Description
Parameters
get_employee
employeeRecordId
list_employees
employeeTypes?includeFutureStarts?includeInactive?includeTerminated?workspaceId?
list_managed_employees
employeeTypes?includeFutureStarts?includeInactive?includeTerminated?workspaceId?
create_employeewrites
essentialscustomPropertiesisTrial?workspaceId?
update_employeewrites
employeeRecordIdavatarURL?customProperties?employeeType?workEmail?
invite_employee_to_winslowwrites
employeeRecordIdcustomMessage?
get_employee_invite_linkwrites
employeeRecordId
Employee Documents
Winslow-stored employee documents, plus the unified Check / SPD document view.
Scopesemployee:manage-benefitsemployee:manage-documentsemployee:manage-payrollself:manage-benefitsself:manage-documentsself:manage-payroll
Tool
Description
Parameters
list_employee_documents
employeeRecordIdtype?
get_employee_document
employeeRecordIdemployeeDocumentId
find_employee_documents
employeeRecordIdsearchQuerylimit?type?workspaceId?
begin_employee_document_uploadwrites
employeeRecordIdfileNametype?workspaceId?
upload_employee_documentwrites
employeeRecordIdfileNamefileBase64type?workspaceId?
get_employee_document_resource
employeeRecordIdemployeeDocumentId
get_employee_document_content
employeeRecordIdemployeeDocumentIdformat
set_employee_document_validationwrites
employeeRecordIdemployeeDocumentIdvalidation?agentData?
get_employee_documents
employeeRecordIdtype?workspaceId?
get_employee_payroll_document
employeeRecordIddocumentIdtypeworkspaceId?
Employee Benefits
Employee-facing reads over the CURRENT coverage timeline — the same data as the Employee Record Benefits tab.
Scopesemployee:manage-benefitsself:manage-benefits
Tool
Description
Parameters
get_employee_benefits
employeeRecordIdworkspaceId?
list_employee_benefit_spds
employeeRecordIdplanTypes?workspaceId?
get_employee_benefit_spd_document
employeeRecordIdattachmentRefoffset?maxChars?limit?workspaceId?
Benefits Administration — Plan Catalog & Selection Lifecycle
Admin surface for the plan catalog and the stakeholder plan-selection review. Reads also accept the caller's own self:manage-benefits.
Scopesbenefits:manage-plansself:manage-benefits
Tool
Description
Parameters
list_benefit_plans
workspaceId?
get_benefit_plan
planIdworkspaceId?
create_benefit_planwrites
carrierIdbrokerIdnameplanTypecarrierPlanUrl?employerContribution?groupNumber?notes?planCode?policyNumber?sbcUrl?states?workspaceId?
update_benefit_planwrites
planIdbrokerId?carrierId?carrierPlanUrl?employerContribution?groupNumber?name?notes?planCode?planType?policyNumber?sbcUrl?states?status?workspaceId?
delete_benefit_planwrites
planIdworkspaceId?
finalize_plan_selectionwrites
selectedPlanIdscontributions?waivedTypes?workspaceId?
list_plan_offerings
planId?coveragePeriodId?workspaceId?
get_plan_offering
planOfferingId
create_plan_offeringwrites
planIdcoverageData?coveragePeriodId?effectiveFrom?effectiveTo?employerContribution?quotingData?
update_plan_offeringwrites
planOfferingIdcoverageData?effectiveFrom?effectiveTo?employerContribution?quotingData?
delete_plan_offeringwrites
planOfferingId
copy_plan_offerings_from_previouswrites
planIdcoveragePeriodId
get_plan_selection_status
workspaceId?
create_plan_selectionwrites
workspaceId?
open_plan_selectionwrites
workspaceId?
close_plan_selectionwrites
workspaceId?
reset_plan_selectionwrites
workspaceId?
get_benefits_configuration
workspaceId?
update_benefits_configurationwrites
hasFullCensusworkspaceId?
Benefits Administration — Coverage Periods, Enrollment & Elections
Open-enrollment windows, per-employee election state, and finalization + sync to Check. The employee-facing election tools also accept self:manage-benefits on the caller's own record.
Scopesbenefits:manage-oebenefits:manage-qleemployee:manage-benefitsself:manage-benefits
Tool
Description
Parameters
list_coverage_periods
workspaceId?
get_coverage_period
coveragePeriodIdworkspaceId?
create_coverage_periodwrites
startDateendDatecoverageEffectiveDatecoverageEndDateworkspaceId?
update_coverage_periodwrites
coveragePeriodIdcoverageEffectiveDate?coverageEndDate?endDate?startDate?workspaceId?
delete_coverage_periodwrites
coveragePeriodIdworkspaceId?
activate_open_enrollmentwrites
coveragePeriodIdworkspaceId?
close_open_enrollmentwrites
coveragePeriodIdworkspaceId?
get_enrollment_tracking
coveragePeriodIdworkspaceId?
send_enrollment_reminderswrites
coveragePeriodIdemployeeRecordIdssubjectbodyworkspaceId?
get_employee_enrollment
employeeRecordIdcoveragePeriodId?workspaceId?
get_election_history
employeeRecordIdworkspaceId?
update_employee_electionwrites
electionIdplanIdcoverageTierdependentIds?workspaceId?
waive_employee_electionwrites
electionIdwaiveReason?workspaceId?
clear_employee_electionwrites
electionIdworkspaceId?
submit_employee_enrollmentwrites
employeeRecordIdcoveragePeriodIdsignatureworkspaceId?
list_period_elections
coveragePeriodIdworkspaceId?
finalize_open_enrollmentwrites
coveragePeriodIdacknowledgedworkspaceId?
admin_update_electionwrites
coveragePeriodIdelectionIdcarrierEnrollmentData?carrierMemberId?coverageEffectiveDate?coverageEndDate?coverageTier?dependentIds?employeePremium?employerContribution?note?planId?workspaceId?
set_election_statuswrites
coveragePeriodIdelectionIdstatusworkspaceId?
Benefits Administration — Qualifying Life Events (QLE)
The QLE side-channel, independent of the OE lifecycle. QLE elections are never written by an admin tool — they stay employee-attested.
Scopesbenefits:manage-oebenefits:manage-qleemployee:manage-benefitsself:manage-benefits
Tool
Description
Parameters
preview_life_event_requirements
eventTypechangeActions
file_life_event_requestwrites
employeeRecordIdeventTypeeventDatedescriptionchangeActionsaffectedPlanTypesrequirementsData?workspaceId?
list_life_event_requests
workspaceId?
list_employee_life_event_requests
employeeRecordIdworkspaceId?
get_life_event_request
lifeEventRequestIdworkspaceId?
update_life_event_request_statuswrites
lifeEventRequestIdstatusnotes?workspaceId?
get_qle_enrollment
employeeRecordIdlifeEventRequestIdworkspaceId?
Benefit Adjustments
Overrides to an employee's benefit deduction amounts. ONGOING changes the standing Check benefit; ONE_TIME overrides a single payroll.
Scopesemployee:manage-benefitspayroll:manage-payrolls
Tool
Description
Parameters
list_benefit_adjustments
checkPayrollId?employeeRecordId?workspaceId?
get_benefit_adjustment
benefitAdjustmentId
create_benefit_adjustmentwrites
employeeRecordIdbenefitElectionIdadjustmentTypeemployeeAmountcompanyAmountcheckPayrollId?workspaceId?
update_benefit_adjustmentwrites
benefitAdjustmentIdbenefitElectionId?checkPayrollId?companyAmount?employeeAmount?
delete_benefit_adjustmentwrites
benefitAdjustmentId
Payroll — Runs & Lifecycle
Create, refresh, calculate, approve and reopen payroll runs. approve_payroll and reopen_payroll need the separate payroll:approve scope — money moves on approve.
Scopespayroll:approvepayroll:manage-payrolls
Tool
Description
Parameters
list_payrolls
limit?paydayAfter?paydayBefore?timeframe?workspaceId?
get_payroll
payrollIdworkspaceId?
create_next_regular_payrollwrites
workspaceId?
rename_payrollwrites
payrollIdnameworkspaceId?
calculate_payrollwrites
payrollIdworkspaceId?
refresh_payrollwrites
payrollIdworkspaceId?
refresh_payroll_itemswrites
payrollIdselectedContractorRecordIds?selectedEmployeeRecordIds?workspaceId?
get_payroll_refresh_status
payrollIdworkspaceId?
get_payroll_comparison
payrollIdworkspaceId?
get_payroll_taxes
payrollIdworkspaceId?
approve_payrollwrites
payrollIdworkspaceId?
reopen_payrollwrites
payrollIdworkspaceId?
set_payroll_employee_exclusionwrites
payrollIdemployeeRecordIdactionworkspaceId?
Payroll — Off-Cycle & Termination Pay
General off-cycle runs, and the final-pay off-cycle attached to a termination.
Scopesemployee:terminatepayroll:manage-payrolls
Tool
Description
Parameters
get_offcycle_payroll_payment_constraints
payday
create_offcycle_payrollwrites
namepaydaypaymentMethodapplyBenefits?applyPostTaxDeductions?employeeMode?employeeRecordIds?contractorRecordIds?workspaceId?
update_offcycle_payrollwrites
payrollIdapplyBenefits?applyPostTaxDeductions?name?paymentMethod?workspaceId?
delete_offcycle_payrollwrites
payrollIdworkspaceId?
create_termination_payrollwrites
terminationIdpayrollDate?severanceAmount?payOutPto?ptoPayoutAmount?ptoPayoutHours?workspaceId?
Payroll — Expenses & Reimbursements
Two related surfaces: *_payroll_expense (employee expense rows) and *_payroll_reimbursement (Winslow reimbursements on a payroll). Both mark the payroll dirty — follow with refresh_payroll.
Scopespayroll:manage-adjustmentspayroll:manage-payrolls
Tool
Description
Parameters
list_payroll_expenses
employeeRecordId?payrollId?workspaceId?
add_payroll_expensewrites
payrollIdemployeeRecordIdamountdescriptioncode?note?workspaceId?
remove_payroll_expensewrites
expenseIdworkspaceId?
list_payroll_reimbursements
payrollIdworkspaceId?
create_payroll_reimbursementwrites
payrollIdemployeeRecordIdamountdescriptioncode?note?workspaceId?
update_payroll_reimbursementwrites
reimbursementIdamount?code?description?note?workspaceId?
delete_payroll_reimbursementwrites
reimbursementIdworkspaceId?
Payroll — Pay Stubs
Employee-facing and admin-facing pay stub reads.
Scopesemployee:manage-payrollpayroll:manage-payrollsself:manage-payroll
Tool
Description
Parameters
get_pay_stubs
employeeRecordIdendDate?limit?offset?startDate?workspaceId?
get_pay_stub
employeeRecordIdpayrollIdworkspaceId?
search_pay_stubs
employeeRecordIdstartDate?endDate?offset?limit?workspaceId?
list_payroll_paystubs
payrollIdworkspaceId?
Payroll — Configuration, Approval Settings & Tax Parameters
Workspace payroll configuration, auto-approval behavior, and read-only Check tax parameters.
Scopesemployee:manage-payrollpayroll:approvepayroll:manage-payrollsself:manage-payroll
Tool
Description
Parameters
get_payroll_config
workspaceId?
get_payroll_signatory
workspaceId?
list_workplaces
workspaceId?
get_company_tax_parameters
workspaceId?
get_employee_tax_parameters
employeeRecordIdworkspaceId?
get_payroll_approval_settings
workspaceId?
update_payroll_approval_settingswrites
approveWithPayrollIssues?approveWithUnenrolledEmployees?autoApproveDeviationAmount?autoApproveDeviationPercent?autoApproveMatchMode?autoApproveOffCycle?autoApproveRegular?autoApproveTermination?workspaceId?
get_payroll_auto_approve
workspaceId?
set_payroll_auto_approvewrites
enabledworkspaceId?
set_payroll_auto_approve_overridewrites
payrollIdautoApproveworkspaceId?
Payroll — Employee Status
Per-employee payroll enrollment and upcoming-pay lookups.
Scopesemployee:manage-payrollself:manage-payroll
Tool
Description
Parameters
get_employee_payroll_status
employeeRecordIdworkspaceId?
get_employee_upcoming_payroll
employeeRecordIdworkspaceId?
Payroll Adjustments
Recurring adjustment templates and their per-payroll instances. Every tool here needs payroll:manage-adjustments — scope-only, no per-record relationship check.
Scopespayroll:manage-adjustments
Tool
Description
Parameters
list_payroll_adjustment_templates
workspaceId?
get_payroll_adjustment_template
templateId
create_payroll_adjustment_templatewrites
nametargetTyperecurrenceTypeamountTypecheckPayrollItemTypeactiveassignedAmounts?blocking?departments?description?fixedAmount?oneTimeOnPayroll?targetEmployeeIds?targetEmployeeTypes?workspaceId?
update_payroll_adjustment_templatewrites
templateIdactive?amountType?assignedAmounts?blocking?checkPayrollItemType?departments?description?fixedAmount?name?oneTimeOnPayroll?recurrenceType?targetEmployeeIds?targetEmployeeTypes?targetType?
delete_payroll_adjustment_templatewrites
templateId
list_payroll_adjustments
checkPayrollId?employeeRecordId?workspaceId?
get_payroll_adjustment
adjustmentId
create_payroll_adjustmentwrites
employeeRecordIdnameamountcheckPayrollItemTypecheckPayrollId?notes?payrollAdjustmentTemplateId?status?workspaceId?
update_payroll_adjustmentwrites
adjustmentIdamount?checkPayrollId?checkPayrollItemType?name?notes?overridden?status?
delete_payroll_adjustmentwrites
adjustmentId
Time Off & Holidays
Time-off requests and the company holiday calendar.
Scopesself:manage-requeststime-off:manage-requests
Tool
Description
Parameters
list_time_off
endDate?startDate?workspaceId?
create_time_off_requestwrites
employeeRecordIdpaidTimeOffPolicyIdstartDateendDateleavePolicyId?notes?workspaceId?
cancel_time_off_requestwrites
timeOffRequestId
approve_requestwrites
timeOffRequestIdstatus
list_company_holidays
Company holidays with concrete dates resolved for a year, floating holidays included.
workspaceId?year?
Invoices
The contractor and vendor invoice lifecycle.
Scopesemployee:manage-invoicespayroll:manage-invoicesself:manage-invoices
Tool
Description
Parameters
create_invoicewrites
employeeRecordIdemployeeInvoiceNumbersubmissionDatedueDateamountcloudURLnote?workspaceId?
submit_invoicewrites
employeeRecordIdattachmentId?fileBase64?fileName?note?workspaceId?
list_invoices
employeeRecordIdstatus?workspaceId?
approve_invoicewrites
invoiceId
reject_invoicewrites
invoiceId
unapprove_invoicewrites
invoiceId
cancel_invoicewrites
invoiceId
Terminations
Termination records, state final-pay timing rules, and the termination itself.
Scopesemployee:terminate
Tool
Description
Parameters
list_terminations
workspaceId?
get_termination_payment_date_info
employeeRecordIdterminationDatetype?
terminate_employeewrites
employeeRecordIdterminationDatepaymentDatetypepaymentMethodnote?severanceAmount?payOutPto?ptoPayoutAmount?ptoPayoutHours?createOffcyclePayroll?workspaceId?
Approvals
The generic approval-task surface.
Scopestime-off:manage-requests
Tool
Description
Parameters
get_approval_state
approvalId
cancel_approvalwrites
approvalId
update_approvalwrites
approvalIdname?description?status?
Organization
Departments and the reporting hierarchy.
Scopesemployee:manage-data
Tool
Description
Parameters
list_departments
Departments, from the system-department dropdown choices.
workspaceId?
list_org_chart
workspaceId?
Custom Properties
Workspace custom property definitions, and app-namespaced properties.
Scopesadmin:manage-customizationemployee:manage-data
Tool
Description
Parameters
list_custom_properties
workspaceId?
list_app_properties
appIdworkspaceId?
create_app_propertywrites
appIdlabeldisplaytypedescription?group?required?settings?workspaceId?
Artifacts — Employee Data Storage
App-scoped records attached to an employee. A non-admin caller can only write to an appId namespace that's already registered.
Scopesadmin:manage-artifactsemployee:manage-data
Tool
Description
Parameters
create_artifactwrites
employeeRecordIdappIdtypeappName?content?employeeVisible?fileName?payload?url?
update_artifactwrites
artifactIdcontent?fileName?payload?url?
list_artifacts
employeeRecordIdappId?
delete_artifactwrites
artifactId
register_artifact_appwrites
appIdnamedescriptionfaviconUrl?
Automation — Scheduled Tasks
Your own recurring tasks, on a 5-field cron and an IANA timezone. Every tool acts only on the caller's tasks.
Scopesagents:automate
Tool
Description
Parameters
schedule_taskwrites
promptcrontimezonedestination?
Automation — Event Subscriptions
Your own event subscriptions: when a Winslow event fires, the agent runs your prompt and delivers the result.
Scopesagents:automate
Tool
Description
Parameters
subscribe_eventwrites
eventKeypromptobjectType?fieldFilters?destination?
update_subscriptionwrites
iddestination?eventKey?fieldFilters?objectType?prompt?
enable_subscriptionwrites
id
pause_subscriptionwrites
id
cancel_subscriptionwrites
id
Automation — Workspace Skills
Reusable HR and process playbooks shared with everyone in the workspace.
Scopesadmin:manage-customization
Tool
Description
Parameters
save_skillwrites
namedescriptionbody
update_skillwrites
namedescriptionbody
Automation — Agent Sequences
Durable cross-session state and checklists for multi-step agent workflows.
Scopesagents:manage
Tool
Description
Parameters
upsert_sequencewrites
keyanchorAt?objectId?objectType?
update_sequencewrites
idstate?status?
Automation — Slack
Slack destinations and agent-run follow-ups.
Scopesagents:automateagents:manage
Tool
Description
Parameters
resolve_slack_channel
query
send_slack_dmwrites
employeeRecordIdmessagerecipient?
check_employee_reply
employeeRecordIdsinceISO
AI & Knowledge Base
RAG over workspace HR policy documents, and natural-language reporting over employee data.
Scopesemployee:manage-data
Tool
Description
Parameters
ask_policy_question
question
ask_reporting_question
question
OAuth App Management
Register and maintain "Login with Winslow" OAuth apps for this workspace.
Scopesadmin:manage-customization
Tool
Description
Parameters
register_oauth_appwrites
nameredirectUrisscopes?description?framework?
update_oauth_appwrites
clientIdaddRedirectUris?description?iconUrl?name?redirectUris?removeRedirectUris?scopes?
delete_oauth_appwrites
clientId
Feedback
Report bugs and suggest improvements to the MCP API.
ScopesNone — any workspace member
Tool
Description
Parameters
report_bugwrites
Report something that errored, misbehaved or returned the wrong result.
titledescription?toolName?agentContext?
suggest_improvementwrites
Suggest an improvement or a new capability.
titledescription?toolName?agentContext?
Documentation
Self-describing API documentation.
ScopesNone — any workspace member
Tool
Description
Parameters