Jump to Content

Documentation API Specifications UKG Webhooks Integrations Dashboard

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 UKG Webhooks Integrations Dashboard

Welcome

Welcome to the UKG Pro API

Audit

AuditDetails
- Get Audit Details Dataget
IntegrationAuditConfiguration
- Get Integration Audit Configuration Dataget

Configuration Setup

CodeTables
- Get Code Tables informationget
- Post Code Tables informationpost
CompanyDetails
- Get Company Detailsget
Earnings
InsRate
- Get Insurance Rateget
JobGroup
- Get All Job Groupsget
Jobs
Locations
- Retrieve all locations configurationsget
- Retrieve a single location configurationget
OptionRate
- Get Option Rate Dataget
Single Organization Level
Organization Reporting Category
- Get Organization Reporting Categoryget
PositionReport
- Get Position Reportget
Positions
- Returns list of employee position information filtered on various parametersget
ShiftCode
- Shift Codes API Dataget
Tax Groups
- Get all tax group detailsget
Allergy
User Profile Details
- Get all user profile detailsget
View or Create Organization Levels
- Get all org-levelsget
- Create org-level configurationpost
AwardType
Career Provider
ChildSupportType
CobraStatus
CompanyProperty
CourseCategory
CourseDeliveryMet
CourseSubCategory
Disability
EmployeeType
JobFamily
LicenseType
LoanType
MaritalStatus
MilitaryBranches
MilitaryEra
NamePrefix
OtherPhoneTypes
Project
School
SkillProficiencyLevel
Skills
TermType
WaiveReason

Onboarding

New Hires

PRO Employee Data

BusinessStructureStatus
- Gets a list of Employees for which there is a change in business structureget
CompensationDetails
Changes By Date
- Changes By Dateget
EmployeeCobraDetails
- Get Employee Cobra Detailsget
Contact
- Get all details for a person assigned to an employee as a contactget
- Get all details for a single person assigned to an employee as a contactget
EmployeeContract
- Get all employment contract detailsget
EmpDedBenOptionDate
- Get Employee Deduction Benefit Option Change Dateget
Employee Deduction History Effective Date
- Deductions History Effective Change Dateget
Employee Demographic Details
- Get Employee Demographic Detailsget
EmployeeEducation
- Get all education detailsget
EmployeeEmploymentDetails
- Retrieve Employee Employment Detailsget
EmployeeExtendedElements
- Get Employee Extended Elementsget
EmployeeJobHistoryDetail
- Get all employee job history detailsget
- Get a single job history detail recordget
Employee ID Lookup
- Employee ID Lookuppost
EmployeeMultipleJobsOPP
- Get employee multiple jobs detailsget
EmployeeMultiPhoneNumbers
- Get employee multiple phone numbersget
EmpMultiplePositions
- Get Employee Multiple Positionsget
NationalDocument
- All employee national document detailsget
KronosEmployeeProfiles
- Get list of employees profileget
EmployeeSupervisorDetails
- Get Employee Supervisor Detailsget
KronosEmployeeStatus
- Get Employee Statusget
EmploymentDetails
EmployeeGlobalBank
- Get all direct deposit details for global employeesget
EmpGlobalLocalizationElement
- Get all global employee localization fields added to UKG Proget
EmployeePayDeductionElement
- Get Global Employee Payments and Deductions Serviceget
InternationalEmployee
- Get international employee details for all employeesget
- Get a single employees international detailsget
OpenEnrollmentEmployeeDeductions
- Get Open Enrollment Employee Deductionsget
EmpDeductions
- Get employee deductionsget
DependentDeductions
- Get Dependent Deductionsget
Employee Changes
- Changes By Employee IDget
OpenEnrollmentDependentDeductions
- Get Open Enrollment Dependent Deductions Dataget
PersonDetails
Get All PTO Plans
- Get all pto-plansget
PTO Plan Post
- Create A PTO Planpost
PTO Plan Patch
- Patch one PTO Planpatch
Get Specific PTO Plan
- Get a specific pto-planget
Get Specific Employees PTO Plans
- Get a specific employees pto-plansget
UserDefinedFields
User Preferences
- Get User Preferences Detailsget

PRO Import Tools

BusinessRuleImportTool
ImportTool
- Takes an XML transaction and feeds it into the Import Toolpost
- Retrieves the status of an import tool transactionget

PRO Platform Configuration

PlatformConfigurationCustomFieldsSchema
- Gets Platform Configuration standard classes custom fields schemaget
V1 PlatformConfigurationCustomFieldsData
- Platform Configuration Fields Data v1get
V2 PlatformConfigurationCustomFieldsData
- Platform Configuration Fields Data v2get

PRO Security

Employee Security User Details
- Get employee security user detailsget
RolesGet
- Gets Roles from security roles tableget
UserDetails
- Get User Detailsget

Payroll

EarningsHistory
- Get Earnings History Base Elementsget
DirectDeposit
- Get list of direct deposit details for US and Canadian employeesget
- Get list of direct deposit details for US and Canadian employees by companyget
CompanyPayStatement
- Get employee(s) pay statement(s) summary for a company or pay group for a given date range.post
- Get employee(s) pay statement(s) for a company or pay group for a given date range.post
GeneralLedgerRunDetailsV2
- Retrieve General Ledger Runsget
- Retrieve General Ledger Run by IDget
PayRegister
- Get Pay Registerget
PayGroupPayPeriod
- Get PayGroup PayPeriodsget
PayrollDeductionsHistory
- Get Payroll Deductions Historyget
Earnings
Accruals
Deductions
EarningPendingItems
- Create Earnings Pending Pay Itempost
- Retrieve Earnings Pending Pay Item by IDget
PayDetailsReport
- Automatic retrieve finalized pay history details from UKG Pro. This includes earnings, deductions, and tax data.post
EmployeePayStatement

Recruiting

Applications
Application Disposition Events
Background Checks
Candidates
Configuration and Settings
Offers
Opportunities
Prehire Assessments and WOTC Surveys
Third Party Job Sites
- Retrieve Third Party Job Site Postings by Integration IDget
- Retrieve Application Disposition Events by Third Party Job Site Integration IDget
Post new token request
- Obtain New oAuth Tokenpost
Get Job Postings
- Get job postingsget

UTA

Time
Activities
- Obtains all activities.get
User
- Obtains the current user information.get
Assigned Holidays
- Obtains all assigned holidays.get
Employee Jobs
- Obtains all jobs for an employee.get
Employees
- Obtains all employees.get
Hour Types
- Obtains all hour types.get
Schedule Details
- Publish schedule details.put
Teams
- Obtains all teams.get
Time Codes
- Obtains all time codes.get
Time Off Requests
- Obtains all time off requests.get
UTA Employee
- Obtains a UTA Employee by coId and eeId.get

Create a new allergy configuration

post https://{hostname}/configuration/v1/code-tables/allergy/

'Creates a new UKG Pro allergy configuration.'

Language

Credentials

Basic

base64

:

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.