Jump to Content

Documentation API Specifications

What's New UKG.com Marketplace UKG Pro status Log In

API Specifications

What's New UKG.com Marketplace UKG Pro status Log In

Documentation API Specifications

Welcome

Welcome to the UKG Pro Workforce Management API

Activities

Active Team Members
- Retrieve Active Team Memberspost
Activity
Activity Actions
Activity Assignments
- Retrieve Activities for Multiple Employeespost
Activity Customers
Activity Efficiencies
- Retrieve Activity Efficienciespost
Activity Form Profiles
Activity Form Resources
Activity Forms
Activity Historical Net Changes
- Retrieve Historical Net Changes for Activity Shiftspost
Activity Move Quantity Transaction Audits
- Retrieve Activity Move Quantity Transaction Auditspost
Activity Net Changes
- Retrieve Net Changes for Activity Shiftspost
Activity Profile Resources
Activity Profiles
Activity Queries
Activity Query Profiles
Activity Query Resources
- Retrieve All Activity Query Date Range Date Typesget
- Retrieve All Query Typesget
Activity Resource Queries
Activity Resources
Activity Resources Data Retrieval
Activity Results Template Resources
- Retrieve All Step Typesget
Activity Results Templates
Activity Settings
Activity Shifts
Activity Team Resources
- Retrieve All Days of a Weekget
Activity Team Segment Audits
- Retrieve Activity Team Segment Auditspost
Activity Team Segments
Activity Teams
Activity Totals
- Retrieve Activity Totalsget
- Retrieve Activity Totals for Multiple Employeespost
Activity Transactions
- Retrieve Activity Transactionspost
Field Definitions
Result Code Profiles
Result Codes
Team Segments Net Changes
- Retrieve Net Changes for Team Segmentspost
Team Transactions
- Retrieve Team Transactionspost
Units of Measure

Attendance

Actions
Attendance Audit Records
- Retrieve Attendance Audit Recordspost
Attendance Profiles
Balance Adjustments
Balance Expirations
- Retrieve Expiring Balancespost
Balance Resets
Balances
- Retrieve Balancespost
Discipline Levels
- Retrieve Discipline Levelspost
Events
Markers
Perfect Attendance
- Retrieve Perfect Attendance Transactionspost
Perfect Attendance Deductions
- Retrieve Perfect Attendance Deductionspost
Processor Requests
Profile Assignments
- Retrieve Profile Assignmentspost
Rules
- Execute Attendance Rules for Employeespost

Common Resources I

Access Control Points
- Retrieve All Access Control Pointsget
Access Method Profiles
Average Pay Rate Sets
Average Pay Rates
- Retrieve Average Pay Rate - One Locationpost
Biometric Consent History
- Retrieve Biometric Consent Historypost
Bulk Downloads
Comments
- Retrieve Comments as Managerget
- Retrieve Comments as Employeeget
Control Center Profiles
Cost Centers
Custom Tiles
Delegate Profiles
Device Groups
- Retrieve Device Groupsget
Display Profiles
Domain Event Categories
Domain Event Navigations
Domain Events
Dynamic Event Notification Mappings
Dynamic Event Notifications
- Send Dynamic Event Notificationspost
Employee Groups
Employee Photos
- Retrieve Photos for Multiple Employeespost
Entitlements
- Entitlement Historyget
- Entitlement Summaryget
Feature Switches
- Retrieve Feature Switchespost
- Retrieve Feature Switch by Nameget
Fiscal Calendars
- Create Fiscal Periodspost
- Delete Fiscal Periodspost
Function Access Profiles
Generic Data Access Profiles
Generic Notifications
Hours of Operation
Hours of Operation Assignments
Hours of Operation Override Assignments
Hours of Operation Overrides
Known IP Addresses
Messaging Notifications
Notification Profiles
Pay Period Timespans
- Retrieve Pay Period Timespansget
Payroll Export
Payroll Staging
Payroll Tables
Proactively Guide Employees - Behaviors Configuration
Proactively Guide Employees - Behaviors Configuration Items
Process Profiles
Reviewer Lists
Reviewer Purposes
Role Profiles
Symbolic Periods
Symbolic Purposes
Symbolic Reviewers and Listeners
- Retrieve Symbolic Reviewers and Listenerspost
TeleTime IP User Profiles
- Retrieve TeleTime IP User Profilesget
Timecard Approval Methods
- Retrieve Timecard Approval Methodsget
Timezones
Transaction Assistant
- Retrieve All Transaction Assistant Recordspost
Transfer Display Profiles
WiFi Access Points
WiFi Networks

Common Resources II

Aggregated Data
- Retrieve Datapost
Currency Definitions
- Retrieve All Currency Definitionsget
- Retrieve Currency Definition by IDget
Currency Policies
Data Dictionary
- Retrieve Data Element Definitionsget
- Retrieve Data Element Definitions by Keyspost
Dataview Profiles
Dataviews
Exchange Rates
- Retrieve Converted Amountpost
GPS Known Places
Generic Locations
Home Pages
Hyperfind Profiles
Hyperfind Queries
Jobs
Labor Categories
Labor Category Entries
Labor Category List Assignments
Labor Category Lists
Labor Category Profiles
Labor Entry Lists
- Retrieve Labor Entry Listspost
Locale Policies
Location Attribute Assignments
- Retrieve Location Attribute Valuepost
Location Attribute Start Day Of Week
- Retrieve a Location Attribute Week Spanpost
Location Attributes
Location Sets
Location Types
Locations
Tiles
Time Increment Resolver
- Resolve Time Incrementspost
User Preferences
- Retrieve User Preferencesget
- Retrieve User Preferences for Current Userget

Employee Self-Service

Employee Availability Pattern Requests
Employee Availability Requests
Employee Cover Requests
Employee Open Shift Requests
Employee Schedules
- Retrieve Employee Scheduleget
Employee Self-Schedule Requests
Employee Swap Requests
Employee Time Off Requests
Fill Open Shifts
Manager Availability Pattern Requests
- Update Availability Pattern Request State as Managerpost
- Retrieve Availability Pattern Requests as Managerpost
Manager Availability Requests
- Update Availability Request State as Managerpost
- Retrieve Availability Requests as Managerpost
Manager Cover Requests
Manager Open Shift Requests
Manager Self-Schedule Requests
- Retrieve Self-Schedule Requests as Managerpost
Manager Swap Requests
Manager Time Off Requests
Time Off Request Guided Recommendations
- Retrieve Guided Recommendationspost

Forecasting Setup

Adjustment Driver Settings
Budget Distribution Types
- Retrieve All Budget Distribution Typesget
Category Property Set Assignments
Category Property Sets
Combined Labor Distributions
Custom Driver Assignments
Custom Drivers
Forecast Planner Profiles
Forecast Planner Settings
Forecast Week
- Retrieve a Forecast Week (Deprecated)get
- Retrieve a Forecast Weekget
Forecast Week Start Days
Generic Categories
Generic Departments
- Retrieve All Generic Departments or by Nameget
- Retrieve Generic Department by IDget
Hours of Operation Assignments (Deprecated)
Hours of Operation Override Assignments (Deprecated)
Hours of Operation Overrides (Deprecated)
Labor Constraint Profiles
Labor Constraint Settings
Labor Distribution Group Profiles
Labor Distribution Groups
Labor Forecast
Labor Forecast Limits
Labor Standards
Labor Standards, Tasks, and Task Groups
Labor Tasks
Linked Categories
Linked Category Action Types
- Retrieve Linked Category Action Typesget
Machine Learning Models
Period of Application Types
- Retrieve Period of Application Typesget
Special Event Assignments
Special Events
Static Driver Assignments
Static Drivers
Task Groups
Volume Driver Assignments
Volume Drivers
Volume Forecast Model Types
- Retrieve All Volume Forecast Model Types (Deprecated)get
- Retrieve All Volume Forecast Model Typesget

Forecasting

Accuracy Metrics Engine
- Execute Accuracy Metrics Enginepost
Actual Volume
Adjustment Drivers
Basic Accuracy Engine
- Execute Basic Accuracy Metrics Enginepost
- Delete Basic Accuracy Metricspost
Combined Distribution Offset Types
- Retrieve Combined Distribution Offset Typesget
Combined Distribution Types
- Retrieve Combined Distribution Typesget
Consolidated Labor Forecast
- Retrieve Consolidated Labor Forecastspost
Custom Drivers Setup
Daily Actual Volume
- Create Daily Actual Volumepost
Earned Hours Engine
- Execute Earned Hours Enginepost
Engine Status
- Retrieve Engine Statusespost
Forecasted Jobs
- Retrieve Forecasted Jobspost
Forecasting Audits
- Retrieve Forecasting Audit Datapost
Forecasting Category Profiles
Labor Budget
Labor Constraint Engine
- Execute Labor Constraint Enginepost
Labor Forecast Analyzer
- Execute Labor Forecast Analyzerpost
Labor Forecast Engine
- Execute Labor Forecast Enginepost
Labor Forecast Limit Assignments
Labor Period Overrides
Machine Learning Model Features
- Retrieve All Machine Learning Model Features or by Nameget
- Retrieve Machine Learning Model Feature by IDget
Peak Hours
- Retrieve Peak Hourspost
SHAP Value Metrics
Traffic Pattern Engine
- Execute Traffic Pattern Enginepost
Traffic Patterns
Volume Analyzer
Volume Budget
- Import Volume Budgetspost
- Retrieve Volume Budgetspost
Volume Forecast
Volume Forecast Engine
- Execute Volume Forecast Enginepost
- Retrieve Volume Forecast Engine Statuspost
Volume Forecast Intervals Engine
- Execute Volume Forecast Intervals Enginepost
Volume Forecasts
- Retrieve Multiple Volume Forecastspost
Week Symbolic Periods
- Retrieve Week Symbolic Period Types (Deprecated)get
- Retrieve Week Symbolic Period Typesget

Healthcare Productivity

Billing Department and Work Unit Maps
- Retrieve All Billing Department and Work Unit Mapsget
- Create or Update Billing Department and Work Unit Mapspost
Charge Masters
Labor Type Agency Recalculation
- Recalculate Agency Asynchronouslypost
- Retrieve Agency Recalculation Asynchronous Request Status by Execution Keyget
Payroll Data Enrichment
- Enrich Payroll Datapost
Payroll Department to Work Unit Maps
- Retrieve Payroll Department to Work Unit Mapsget
- Create or Update Payroll Department to Work Unit Mapspost
Payroll Employment Status to Labor Type Maps
- Retrieve Payroll Employment Status to Labor Type Mapsget
- Create or Update Payroll Employment Status to Labor Type Mapspost
Payroll Job Maps
- Retrieve Payroll Job Mapsget
- Create or Update Payroll Job Mapspost
Raw Volume
- Create or Update Raw Volumepost
Raw Volume Data Errors
- Retrieve All Raw Volume Error Recordsget
- Create or Update Raw Volume Error Recordspost
Volume Copy Maps
- Retrieve All Volume Copy Mapsget
- Create or Update Volume Copy Mapspost
Volume Copy Override Maps
- Retrieve All Volume Copy Override Mapsget
- Create or Update Volume Copy Override Mapspost
Volume Process Status
- Retrieve Volume Process Status by Keyget
Volume Recalculation
- Recalculate Volumepost
Work Unit Hyperfind Profiles
- Retrieve All Work Unit Hyperfind Profilesget
- Create or Update Work Unit Hyperfind Profilespost
Work Unit Hyperfinds
Work Unit Locations
- Retrieve Work Unit Locationspost
Work Units
- Retrieve All Work Unitsget
- Create or Update Work Unitspost

Human Capital Management

HCM Payroll Aggregation
- Retrieve Payroll Data for HCMpost
People Profiles
Profile Field Maps
Profile Templates

Leave

Employee Schedules for Leave
- Retrieve Employee Schedule for Leaveget
Leave Audit Records
- Retrieve Leave Audit Recordspost
Leave Case Certifications
- Retrieve Leave Case Certification Historyget
- Create Leave Case Certificationpost
Leave Case Custom Fields
- Retrieve Custom Fieldsget
- Update Custom Fieldspost
Leave Case Defaults
Leave Case Documents
Leave Case Eligibility Requirements
- Retrieve Eligibility Requirementsget
- Update Eligibility Requirementspost
Leave Case Notes
Leave Case Notifications
Leave Case Rules
Leave Case Statuses
- Retrieve Leave Case Statuses (Deprecated)get
- Retrieve Leave Case Statusesget
Leave Cases
Leave Categories
Leave Custom Fields
- Retrieve Leave Custom Fields by Typeget
Leave Edits
Leave Events
- Retrieve Leave Eventspost
Leave Profiles
- Retrieve All Leave Profilesget
- Retrieve Leave Profile by IDget
Leave Reasons
Leave Request Configuration
- Retrieve Leave Request Configurationget
- Retrieve Leave Request Subtypesget
Leave Requests
Leave Rules
- Retrieve Available Rulesget

People

Employee Glance Setting Resources
- Retrieve All Custom Fieldsget
Employee Glance Settings
Employee Wage Work Rules
- Retrieve Employee Wage and Work Rulespost
- Create or Update Wage and Work Rule Overridespost
People Information Profiles
Persons

Person Assignments

Adjustment Rule Assignments
Aggregated Person Assignments
Attendance Administrator Assignment
Attendance Profile Assignments
Attestation Profile Assignments
- Retrieve Assigned Attestation Profilesget
- Assign Attestation Profilepost
Attestation Profile Assignments by Person Number
Brazil Employee Assignments
Cascade Profile Assignments
Certification Assignments
Direct Assignments
- Retrieve All People Direct Assignment Profilesget
Employee Job Preferences
Employee Tag Assignments
Employment Term Assignments
Forecasting Category Profile Assignments
Leave Administrator Assignment
Leave Profile Assignments
Manager Role Assignments
Minor Rule and School Calendar Assignments
Pattern Template Profile Assignments
Paycode Value Profile Assignments
Percentage Allocation Rule Assignments
Person Common ID
Person TeleStaff Assignments
Process Profile Assignments
Schedule Group Assignments
Schedule Group Profile Assignments
Schedule Override Employee Preferences
Schedule Rule Overrides
Schedule Rule Set Assignments
Scheduling Employee Preferences
School Calendar Profile Assignments
Shift Template Profile Assignments
Skill Assignments
Supervisor Assignments
Worker Type Assignments

Platform

API Integrations
Action Templates
- Retrieve All Announcement Action Templatesget
- Retrieve Announcement Action Template by IDget
Batch Event Scheduling
- Schedule Batch Eventspost
Batch Events
Batch Groups
Batch Job Statuses
- Retrieve Batch Job Statusespost
Batch Job Statuses with Pagination
- Retrieve Batch Job Statuses with Paginationpost
Batch Tasks
Change Indicators
Employee Announcements
- Update Announcement Message Response as Employeepost
- Retrieve Announcement Message Response by ID as Employeeget
File-based Integrations
Integration Executions
Integration List Parameters
- Create or Update Integration List Parameterspost
- Retrieve Integration List Parameter by Nameget
Integration Process Callback
- Update Integration Execution Detailspost
Integration Schedules
Kiosk
Manager Announcements
Mapping Categories
Mapping Category Types
- Retrieve All Mapping Category Types or by Nameget
- Retrieve Mapping Category Type by IDget
Menu Items
- Retrieve All Menu Itemsget
Messaging with Generic Notifications
Publish and Run Reports
Report Categories
- Get All Report Categoriesget
- Get Report Category By Nameget
Report Data Objects
Report Designs
Report Executions
Report Profiles
Report Requests
SFTP Connections
Switch Employment
- Switch Employmentpost
Target Threshold Evaluation Period
- Retrieve Target Threshold Evaluation Periodget
Target Threshold Indicator Texts
- Retrieve All Target Threshold Indicator Textsget
Target Threshold Metric Sets
- Retrieve All Target Threshold Metric Setsget
Target Threshold Operators
- Retrieve All Target Threshold Operatorsget
Target Thresholds
Tenant Information
- Retrieve Tenant Informationget
Workflow Business Processes

Scheduling Setup

Absence Quota Overrides
- Retrieve Absence Quota Overridespost
- Create, Update, or Delete Absence Quota Overridespost
Calendar Profiles
Certifications Setup
Coverage Counting Profiles
Day Type Equivalencies
ESS Calendar Settings
Employee Visibility Periods
Holiday and Unscheduled Day Request Settings
Indicators
Location Profiles Option Sets
Minor Rule Sets
Occurrence Definitions
Partial Shift Settings
Pattern Template Profiles
- Retrieve All Pattern Template Profilesget
Paycode Value Profiles
Period Definitions
Predictive Scheduling
- Retrieve Predictive Scheduling Violationspost
- Retrieve Predictive Scheduling Violations, Hours, and Costspost
Predictive Scheduling Bonus
Predictive Scheduling Rules
Procedure Sets
Proficiency Levels
Request Submission Periods
- Verify Request Item Periodspost
- Open Next Submission Periodpost
Request Subtypes
Schedule Builder Settings
Schedule Change Criteria
Schedule Event Rules
Schedule Events
Schedule Groups
Schedule Patterns
Schedule Periods
Schedule Rule Set Location Assignments
Schedule Rule Sets
Schedule Rules
Schedule Score Definitions
Schedule Score Factors
Schedule Zone Sets
School Calendar Profiles
- Retrieve All Active School Calendar Profilesget
School Calendars
Shift Template Profiles
Shift Templates
Skills Setup
Staffing Dashboard Settings
Staffing Matrices
Staffing Profiles
Standard Shift Set Assignments
Standard Shift Sets
Swap Recommendations Settings Profiles
Symbolic Source Types
Tag Definitions
Team Definitions
Visibility Period Actions
Worker Types
- Retrieve All Worker Typesget
Workload Patterns
Workload Planner Profiles
Zone Categories
Setup Zone Categories

Scheduling

Availabilities
Call Logs
Day Locks
- Lock Multiple Dayspost
- Unlock Multiple Dayspost
Employee Schedule Patterns
Employment Term Schedule Patterns
Employment Terms Paycode Edits
Employment Terms Shifts
Employment Terms for Manager
Group Assignments
- Add Group Membershippost
- Remove Group Membershippost
Group Paycode Edits
Group Schedule Patterns
Group Schedules for Manager
Group Shifts
Leave Edits for Scheduling
Manager Schedule Actions
Manager Schedules
Metrics for Scheduling
- Evaluate Metrics for Schedulingpost
Open Shifts
- Retrieve Calculated Open Shiftspost
Paycode Edits for Scheduling
Procedure Set Engine
- Retrieve Sorted or Eligible Employeespost
Rule Violations
Schedule Audits
- Retrieve Schedule Auditspost
Schedule Generation Engine Strategies
Schedule Generation Profiles
Schedule Generation Setup
Schedule Group Patterns
Schedule Group Profiles
- Retrieve All Schedule Group Profilesget
Schedule Planner Profiles
Schedule Scores
- Retrieve Schedule Scorespost
Schedule Tags
Scheduling Engines
Shift Profile Sets
Shift Profiles
Shifts
Skill and Certificate Profiles
Swap Recommendation Messages
Workload Coverage
Workload Generator
- Generate a Workloadpost
Workload Overrides
Workload Volume
- Update Workload Weights or Update, Lock, or Unlock Workload Volumespost
- Retrieve Workload Volumespost

Timekeeping Bulk Operations

Bulk Asynchronous Paycode Edits
Bulk Enable Edits
- Enable Edits Bulk Updatepost
Bulk Paycode Edits
- Bulk Import Paycode Editspost
- Bulk Delete Paycode Editspost
Bulk Payroll Lock
- Lock Payroll in Bulkpost
Bulk Punches
- Bulk Import Punchespost
Bulk Punches and Paycode Edits
- Bulk Import Punches and Paycode Editspost
Bulk Real Time Punches
- Retrieve Punches in Real Timepost
Bulk Timecard Approvals
- Approve Timecards in Bulkpost
- Bulk Timecard Delete Approvalspost
Bulk Timecard Signoffs
- Bulk Timecard Signoffspost

Timekeeping Setup

Accrual Codes
Accrual Policies
- Retrieve Accrual Policiespost
- Retrieve Accrual Policy by IDget
Accrual Profiles
Adjustment Rules
Bonus and Deduction Rules
Break Rules
Combination Rules
Combined Paycodes for Timekeeping
Employment Terms
Pay Code Tags
Paycode Distributions
Paycodes for Timekeeping
Percentage Allocation Rules
Prevailing Wages
- Retrieve Prevailing Wagesget
- Create or Update Prevailing Wagespost
Punch Interpretation Rules
Time-Off Rules
- Retrieve All Time-Off Rulesget
Timecard Add-On Group Options
- Retrieve Timecard Add-On Group Optionsget
Timekeeping Fixed Rules
Timekeeping Holidays
Timekeeping Overtime Rules
Timekeeping Pay Rules
Work Rules
Holidays

Timekeeping Timecards

Timecard Add-On Columns
- Retrieve Timecard Add-On Columnsget
Timecard Add-On Profiles
Timecard Add-On Types
- Retrieve Timecard Add-On Typesget
Timecard Approvals for Employee
Timecard Approvals for Manager
Timecard Changes
Timecard Changes for Reports
- Retrieve Timecard Changes for Reportspost
Timecard Metrics
- Retrieve Timecard Data for Multiple Employeespost
Timecard Settings
Timecards

Timekeeping

Absence Spans
- Retrieve Absence Spanspost
Accrual Move Balances
- Move Accrual Balances for Multiple Employeespost
Accruals Bulk Transactions
Accruals Bulk Update
- Apply Updates to Accrual Balances for Multiple Employeespost
Accruals from Paycodes
- Retrieve Accrual Codes from Paycodespost
Aggregated Transfer Data
- Return Aggregated Transfer Datapost
Attestation Answers
Attestation Assignments
Attestation Buttons
Attestation Conditions
Attestation Daily Details
- Retrieve Attestation Daily Detailspost
Attestation Display and Submit Forms
- Create Attestation Display Formpost
- Create Attestation Submit Formpost
Attestation Models
- Retrieve All Attestation Modelsget
Attestation Profile Buttons
- Retrieve Attestation Profile Buttonsget
Attestation Profiles
Attestation Questions
Attestation Template Mappings
Attestation Unapproved Timecard Data
- Retrieve Unapproved Timecard Dataget
Attestation Workflow Attributes
- Set Attestation Workflow Attributes by IDpost
Attestation Workflows
- Retrieve Attestation Workflow by Nameget
- Retrieve Attestation Workflows by Nameget
Brazil Compliance Companies
Brazil Compliance Device Groups
Brazil Compliance Devices
Brazil Compliance Digital Signature
- Sign Brazil Compliance Reportspost
Brazil Compliance Identity Types
- Retrieve All Brazil Compliance Identity Types or by Specificationget
- Retrieve Brazil Compliance Identity Type by IDget
Brazil Compliance Paycode Attributes
Brazil Compliance System Settings
- Retrieve Brazil Compliance System Settingsget
Complete Attestation Process
- Complete an Attestation Processpost
Complete Manual Time Entry Attestation Process
- Complete a Manual Time Entry Attestation Processpost
Exception Categories
Exception Tiles
Manual Time Entry Workflows
- Retrieve Manual Time Entry Workflowspost
Paycode Data Access Profiles
Pending Historical Corrections
Sign-off Preparation
Signoffs for Employee
Signoffs for Manager
Start Attestation Process
- Start an Attestation Processpost
Start Offline Attestation Process
- Start an Offline Attestation Processpost
Timecard Annotations
Timekeeping Alert Profiles
Timestamps
Work Rule Data Access Profiles

Universal Device Manager

UDM Device Groups
UDM Device Statuses
- Retrieve All Device Statusesget
- Retrieve a Device Statusget
UDM Devices
- Retrieve All Devicesget

Retrieve Team Definition by Name

get https://{hostname}/api/v1/scheduling/setup/team_definition

This operation returns a team definition by name.

Language

URL

Human Capital Management
Workforce Management
Product Suites
Customer Experience
Developer Experience

©2025 UKG Inc. All rights reserved. For a full list of UKG trademarks, please visit ukg.com/trademarks. All other trademarks, if any, are property of their respective owners.
All specifications are subject to change.