UKG Pro WFM

Connect your AI agents to UKG Pro WFM.

Authentication: OAuth. See Magic Link for the runtime auth flow, or Application credentials to bring your own OAuth app.

Sample use cases

  • List all employees on leave this week and their expected return dates.
  • Pull timecard totals for the current pay period and flag anyone under 40 hours.
  • Find open shifts in a location and show which employees are scheduled nearby.

Available Tools

list_leave_cases

List leave cases (extended absences) for a date range. Returns leave type, dates, and status

get_leave_case

Get a single leave case by ID. Returns leave type, dates, status, and notes

create_leave_case

Create a new leave case for an employee. Provide leave_type_id, start_date, and employee ID

list_accrual_balances

List accrual/PTO balances for employees as of a given date. Returns current and projected balances per accrual policy

list_persons

List persons (employees) in UKG Pro WFM for a date range. Returns person details including name, job, and location

get_person

Get a single person’s details by person ID. Returns name, job, location, hire date, and employment status

create_person

Create a new person (employee) in UKG Pro WFM. Use list_jobs and list_locations to find valid job and location IDs

update_persons

Update one or more persons in UKG Pro WFM. Each update object must include ‘id’ and the fields to change

list_jobs

List jobs (work roles) defined in UKG Pro WFM. Returns job ID, name, and status

list_locations

List work locations defined in UKG Pro WFM. Returns location ID, name, and address

list_hyperfinds

List saved hyperfind employee queries in UKG Pro WFM. Returns query ID and name. Use execute_hyperfind to run them

execute_hyperfind

Execute a saved hyperfind query to get the matching employees. Returns a list of person references

list_schedules

List scheduled shifts for a date range. Returns shift start/end times, employee, job, and location

create_schedule

Create a scheduled shift for an employee. Use list_persons, list_jobs, and list_locations to find valid IDs

delete_schedules

Delete one or more scheduled shifts by shift ID. Use list_schedules to find valid shift IDs

list_shift_swap_requests

List shift swap requests for a date range. Returns requestor, recipient, shift details, and approval status

list_timecards

List timecards for a date range. Returns timecard summaries with hour totals and status

get_timecard

Get the timecard for a specific employee and pay period. Returns daily entries, totals, and approval status

update_timecard

Update a timecard for an employee in a pay period. Supply timecard_data with the fields to change

list_punches

List time punches (clock-in/out events) for a date range. Returns punch type, timestamp, and labor account

import_punches

Import time punches into UKG Pro WFM. Each punch must include employeeId, punchDateTime (ISO 8601), and punchType