Jump to Content

Documentation API Specifications UKG Webhooks Integrations Dashboard

What's New UKG.com Marketplace UKG Pro status

API Specifications

What's New UKG.com Marketplace UKG Pro status

Documentation API Specifications UKG Webhooks Integrations Dashboard

welcome

Welcome to the UKG Pro API

Audit Details

AuditDetails
- Get Audit Details Dataget

Business Rules Import Tool

BusinessRuleImportTool

Bussiness Structure Status

BusinessStructureStatus
- Gets a list of Employees for which there is a change in business structureget

Code Tables

CodeTables
- Get Code Tables informationget
- Post Code Tables informationpost

Company Details

CompanyDetails
- Get Company Detailsget

Compensation Details

CompensationDetails

Employee Deduction Code

Employee Deductions
- Retrieve All Employee Deductionsget

Dependent Deductions

DependentDeductions
- Get Dependent Deductionsget

Earning History Based Elements

EarningsHistory
- Get Earnings History Base Elementsget

Earnings Code

Earnings

Employee Change

Changes By Date
- Changes By Dateget
Employee Changes
- Changes By Employee IDget

Employee Cobra Details

EmployeeCobraDetails
- Get Employee Cobra Detailsget

Employee Contact Details

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

Employee Contract Details

EmployeeContract
- Get all employment contract detailsget

Employee Deduction Benefit Option Change Date

EmpDedBenOptionDate
- Get Employee Deduction Benefit Option Change Dateget

Employee Deduction History Effective Change Date

Employee Deduction History Effective Date
- Deductions History Effective Change Dateget

Employee Demographic Details

Employee Demographic Details
- Get Employee Demographic Detailsget

Employee Direct Deposit Details

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

Employee Education

EmployeeEducation
- Get all education detailsget

Employee Employment Details

EmployeeEmploymentDetails
- Retrieve Employee Employment Detailsget

Employee Extended Elements

EmployeeExtendedElements
- Get Employee Extended Elementsget

Employee Job History

EmployeeJobHistoryDetail
- Get all employee job history detailsget
- Get a single job history detail recordget

Employee Lookup

Employee ID Lookup
- Employee ID Lookuppost

Employee Multiple Jobs

EmployeeMultipleJobsOPP
- Get employee multiple jobs detailsget

Employee Multiple Phone Numbers

EmployeeMultiPhoneNumbers
- Get employee multiple phone numbersget

Employee Multiple Positions

EmpMultiplePositions
- Get Employee Multiple Positionsget

Employee National Documents

NationalDocument
- All employee national document detailsget

Employee Pay Statement

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
EmployeePayStatement

Employee Profile

KronosEmployeeProfiles
- Get list of employees profileget

Employee Security User Details

Employee Security User Details
- Get employee security user detailsget

Employee Status

KronosEmployeeStatus
- Get Employee Statusget

Employee Supervisor Details

EmployeeSupervisorDetails
- Get Employee Supervisor Detailsget

Employment Details

EmploymentDetails

General Ledger Run Details

GeneralLedgerRunDetailsV2
- Retrieve General Ledger Runsget
- Retrieve General Ledger Run by IDget

Global Employee Direct Deposit

EmployeeGlobalBank
- Get all direct deposit details for global employeesget

Global Employee Localization Details

EmpGlobalLocalizationElement
- Get all global employee localization fields added to UKG Proget

Global Employee Payments And Deductions

EmployeePayDeductionElement
- Get Global Employee Payments and Deductions Serviceget

Import Tool

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

Insurance Rate

InsRate
- Get Insurance Rateget

Integration Audit Configuration

IntegrationAuditConfiguration
- Get Integration Audit Configuration Dataget

International Employees

InternationalEmployee
- Get international employee details for all employeesget
- Get a single employees international detailsget

Job Group

JobGroup
- Get All Job Groupsget

Jobs Configuration

Jobs
- Retrieve All Job Configurationsget
- Retrieve Job Configurationget

Locations Configuration

Locations
- Retrieve all locations configurationsget
- Retrieve a single location configurationget

On Demand Pay Hours Worked

Time
- Add hours worked entriespost

Onboarding New Hire

New Hires
- Gets a single New Hire by Idget
- Creates a single New Hirepost

Onboarding and Recruiting Authorization Token

Post new token request
- Obtain New oAuth Tokenpost

Open Enrollment Dependent Deductions

OpenEnrollmentDependentDeductions
- Get Open Enrollment Dependent Deductions Dataget

Open Enrollment Employee Deductions

OpenEnrollmentEmployeeDeductions
- Get Open Enrollment Employee Deductionsget

Option Rate

OptionRate
- Get Option Rate Dataget

Organization Levels

Single Organization Level
View or Create Organization Levels
- Get all org-levelsget
- Create org-level configurationpost

Organization Reporting Category

Organization Reporting Category
- Get Organization Reporting Categoryget

Pay Register

PayRegister
- Get Pay Registerget

PayGroup PayPeriods

PayGroupPayPeriod
- Get PayGroup PayPeriodsget

Payroll Deductions History

PayrollDeductionsHistory
- Get Payroll Deductions Historyget

PAYROLL EARNINGS IMPORT

Earnings

PAYROLL PENDING ITEMS

Deductions
Earnings

Person Details

PersonDetails

Platform Configuration Fields Data

V1 PlatformConfigurationCustomFieldsData
- Platform Configuration Fields Data v1get
V2 PlatformConfigurationCustomFieldsData
- Platform Configuration Fields Data v2get

Platform Configuration Fields Schema

PlatformConfigurationCustomFieldsSchema
- Gets Platform Configuration standard classes custom fields schemaget

Position Report

PositionReport
- Get Position Reportget

Positions

Positions
- Returns list of employee position information filtered on various parametersget

Pto Plans

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

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

Roles

RolesGet
- Gets Roles from security roles tableget

Shift Codes

ShiftCode
- Shift Codes API Dataget

Tax Groups Details

Tax Groups
- Get all tax group detailsget

Third Party Job Boards

Get Job Postings
- Get job postingsget

Time And Attendance Schedule Import

Activities
- Obtains all activities.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

UTA Time Clock

Time

Ukg Pro Codes

Allergy
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

User Defined Fields

UserDefinedFields

User Details

UserDetails
- Get User Detailsget

User Preferences

User Preferences
- Get User Preferences Detailsget

User Profile Details

User Profile Details
- Get all user profile detailsget

welcome

Welcome to the UKG Pro API

Audit Details

AuditDetails
- Get Audit Details Dataget

Business Rules Import Tool

BusinessRuleImportTool

Bussiness Structure Status

BusinessStructureStatus
- Gets a list of Employees for which there is a change in business structureget

Code Tables

CodeTables
- Get Code Tables informationget
- Post Code Tables informationpost

Company Details

CompanyDetails
- Get Company Detailsget

Compensation Details

CompensationDetails

Employee Deduction Code

Employee Deductions
- Retrieve All Employee Deductionsget

Dependent Deductions

DependentDeductions
- Get Dependent Deductionsget

Earning History Based Elements

EarningsHistory
- Get Earnings History Base Elementsget

Earnings Code

Earnings

Employee Change

Changes By Date
- Changes By Dateget
Employee Changes
- Changes By Employee IDget

Employee Cobra Details

EmployeeCobraDetails
- Get Employee Cobra Detailsget

Employee Contact Details

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

Employee Contract Details

EmployeeContract
- Get all employment contract detailsget

Employee Deduction Benefit Option Change Date

EmpDedBenOptionDate
- Get Employee Deduction Benefit Option Change Dateget

Employee Deduction History Effective Change Date

Employee Deduction History Effective Date
- Deductions History Effective Change Dateget

Employee Demographic Details

Employee Demographic Details
- Get Employee Demographic Detailsget

Employee Direct Deposit Details

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

Employee Education

EmployeeEducation
- Get all education detailsget

Employee Employment Details

EmployeeEmploymentDetails
- Retrieve Employee Employment Detailsget

Employee Extended Elements

EmployeeExtendedElements
- Get Employee Extended Elementsget

Employee Job History

EmployeeJobHistoryDetail
- Get all employee job history detailsget
- Get a single job history detail recordget

Employee Lookup

Employee ID Lookup
- Employee ID Lookuppost

Employee Multiple Jobs

EmployeeMultipleJobsOPP
- Get employee multiple jobs detailsget

Employee Multiple Phone Numbers

EmployeeMultiPhoneNumbers
- Get employee multiple phone numbersget

Employee Multiple Positions

EmpMultiplePositions
- Get Employee Multiple Positionsget

Employee National Documents

NationalDocument
- All employee national document detailsget

Employee Pay Statement

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
EmployeePayStatement

Employee Profile

KronosEmployeeProfiles
- Get list of employees profileget

Employee Security User Details

Employee Security User Details
- Get employee security user detailsget

Employee Status

KronosEmployeeStatus
- Get Employee Statusget

Employee Supervisor Details

EmployeeSupervisorDetails
- Get Employee Supervisor Detailsget

Employment Details

EmploymentDetails

General Ledger Run Details

GeneralLedgerRunDetailsV2
- Retrieve General Ledger Runsget
- Retrieve General Ledger Run by IDget

Global Employee Direct Deposit

EmployeeGlobalBank
- Get all direct deposit details for global employeesget

Global Employee Localization Details

EmpGlobalLocalizationElement
- Get all global employee localization fields added to UKG Proget

Global Employee Payments And Deductions

EmployeePayDeductionElement
- Get Global Employee Payments and Deductions Serviceget

Import Tool

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

Insurance Rate

InsRate
- Get Insurance Rateget

Integration Audit Configuration

IntegrationAuditConfiguration
- Get Integration Audit Configuration Dataget

International Employees

InternationalEmployee
- Get international employee details for all employeesget
- Get a single employees international detailsget

Job Group

JobGroup
- Get All Job Groupsget

Jobs Configuration

Jobs
- Retrieve All Job Configurationsget
- Retrieve Job Configurationget

Locations Configuration

Locations
- Retrieve all locations configurationsget
- Retrieve a single location configurationget

On Demand Pay Hours Worked

Time
- Add hours worked entriespost

Onboarding New Hire

New Hires
- Gets a single New Hire by Idget
- Creates a single New Hirepost

Onboarding and Recruiting Authorization Token

Post new token request
- Obtain New oAuth Tokenpost

Open Enrollment Dependent Deductions

OpenEnrollmentDependentDeductions
- Get Open Enrollment Dependent Deductions Dataget

Open Enrollment Employee Deductions

OpenEnrollmentEmployeeDeductions
- Get Open Enrollment Employee Deductionsget

Option Rate

OptionRate
- Get Option Rate Dataget

Organization Levels

Single Organization Level
View or Create Organization Levels
- Get all org-levelsget
- Create org-level configurationpost

Organization Reporting Category

Organization Reporting Category
- Get Organization Reporting Categoryget

Pay Register

PayRegister
- Get Pay Registerget

PayGroup PayPeriods

PayGroupPayPeriod
- Get PayGroup PayPeriodsget

Payroll Deductions History

PayrollDeductionsHistory
- Get Payroll Deductions Historyget

PAYROLL EARNINGS IMPORT

Earnings

PAYROLL PENDING ITEMS

Deductions
Earnings

Person Details

PersonDetails

Platform Configuration Fields Data

V1 PlatformConfigurationCustomFieldsData
- Platform Configuration Fields Data v1get
V2 PlatformConfigurationCustomFieldsData
- Platform Configuration Fields Data v2get

Platform Configuration Fields Schema

PlatformConfigurationCustomFieldsSchema
- Gets Platform Configuration standard classes custom fields schemaget

Position Report

PositionReport
- Get Position Reportget

Positions

Positions
- Returns list of employee position information filtered on various parametersget

Pto Plans

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

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

Roles

RolesGet
- Gets Roles from security roles tableget

Shift Codes

ShiftCode
- Shift Codes API Dataget

Tax Groups Details

Tax Groups
- Get all tax group detailsget

Third Party Job Boards

Get Job Postings
- Get job postingsget

Time And Attendance Schedule Import

Activities
- Obtains all activities.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

UTA Time Clock

Time

Ukg Pro Codes

Allergy
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

User Defined Fields

UserDefinedFields

User Details

UserDetails
- Get User Detailsget

User Preferences

User Preferences
- Get User Preferences Detailsget

User Profile Details

User Profile Details
- Get all user profile detailsget

Obtain a work summary.

get https://{hostname}/time/work_summary

Obtain a work summary by the specified id. Will load a full work summary (includes clock and work detail information).

Language

URL

©2024 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.