Skip to main content
UKG Pro
v3.0.0
56 actions · 2 auth methods
HRISIAM

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

Service Account - REST · Connector Profile

Connect to UKG Pro using Service Account credentials for REST API access. Supports employee data, compensation, payroll,…

Service Account - SOAP · Connector Profile

Connect to UKG Pro SOAP Web Services using LoginService token authentication. Requires Service Account or Web User crede…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Service Account - REST · Link Account

Service Account - SOAP · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

|
|
56 actions
Action
Description
Required scopes
List Person Details
Retrieve a paginated list of person details from UKG Pro REST API
Get Person Details
Retrieve details for a specific person by employee ID from UKG Pro REST API
List Employee Supervisor Details
Retrieve employee-supervisor relationships and reporting hierarchy from UKG Pro REST API
List Employee Multiple Phone Numbers
Retrieve employee phone numbers and contact information from UKG Pro REST API
List Employee Changes By Date
Retrieve employee information changes within a specified date range from UKG Pro
List Employee Changes By Employee ID
Retrieve employee information changes for a specific employee from UKG Pro
List Business Structure Changes
Retrieve a list of employees with business structure changes from UKG Pro
List Compensation Details
Retrieve a paginated list of employee compensation details from UKG Pro REST API
Get Compensation Details By Employee
Retrieve compensation details for a specific employee by their ID
List Employee Job History Details
Retrieve employee job history including position changes, promotions, and salary adjustments
List Earnings History
Retrieve historical earnings data including base elements and pay history from UKG Pro
List Direct Deposits
Retrieve direct deposit details for US and Canadian employees from UKG Pro
List Payroll Deductions History
Retrieve payroll deductions history from UKG Pro
List Pay Group Pay Periods
Retrieve pay group and pay period information from UKG Pro
Get Pay Register
Retrieve pay register data from UKG Pro
Get Employee Pay Statements
Retrieve pay statements for a specific employee within a date range from UKG Pro
Get Employee Last Pay Statement
Retrieve the most recent pay statement for a specific employee from UKG Pro
List Employee Deductions
Retrieve employee benefit deduction information from UKG Pro
List Dependent Deductions
Retrieve dependent benefit deduction information from UKG Pro
List Employee COBRA Details
Retrieve COBRA status and details for employees from UKG Pro
List Open Enrollment Employee Deductions
Retrieve open enrollment employee deduction selections from UKG Pro
List PTO Plans
Retrieve a paginated list of all PTO plans from UKG Pro
Create PTO Plan
Create a new PTO plan record for an employee in UKG Pro
Get PTO Plan
Retrieve a specific PTO plan for an employee from UKG Pro
Update PTO Plan
Update an existing PTO plan for an employee in UKG Pro
List Employee PTO Plans
Retrieve all PTO plans for a specific employee from UKG Pro
List Earnings Configurations
Retrieve a list of all earnings type configurations from UKG Pro
List Organization Levels
Retrieve a list of all organization level configurations from UKG Pro
Create Organization Level
Create a new organization level configuration in UKG Pro
List Company Details
Retrieve a list of all company configurations from UKG Pro
List Job Configurations
Retrieve a list of all job configurations from UKG Pro
Get Job Configuration
Retrieve a specific job configuration from UKG Pro by job code
List Employee Positions
Retrieve a list of employee position information with various filtering options
List Location Configurations
Retrieve a list of all location configurations from UKG Pro
Get Location Configuration
Retrieve a specific location configuration from UKG Pro by location code
List Job Groups
Retrieve a list of all job group configurations from UKG Pro
List Employee Contacts
Retrieve a list of all employee contacts from UKG Pro
Get Employee Contact Details
Retrieve detailed information for a specific employee contact from UKG Pro
List International Employees
Retrieve international employee details for all employees
Get International Employee Details
Retrieve international details for a specific employee
List Global Employee Bank Accounts
Retrieve direct deposit details for global employees
List Global Localization Elements
Retrieve global employee localization fields added to UKG Pro
Get User Details
Retrieve user details from UKG Pro including login information and user status
Get Security Roles
Retrieve security roles from the roles table in UKG Pro
Get Employee Security User Details
Retrieve employee security user details from UKG Pro
Find People
Search for employees based on various criteria such as name, employee number, status, location, and more
Get Person By Employee Identifier
Retrieve an individual employee’s person record using their employee identifier
Find User Defined Fields
Search for employee user-defined fields based on various criteria such as name, employee number, status, location, and m…
Get User Defined Fields By Employee Identifier
Retrieve custom user-defined fields for a specific employee using their employee identifier
Find Jobs
Search for employee job records based on various criteria such as name, employee number, status, location, and more
Get Job By Employee Identifier
Retrieve an individual employee’s job record using their employee identifier
Find Compensations
Search for employee compensation records based on various criteria such as name, employee number, status, location, and…
Get Compensation By Employee Identifier
Retrieve an individual employee’s compensation record using their employee identifier
Find Contacts
Search for employee contact records based on various criteria such as name, employee number, status, location, and more
Get Contact By Employee Identifier
Retrieve all contact records for an employee using their employee identifier (returns multiple contacts as an array)
Get Employee Contact By Contact ID
Retrieve a specific contact record using the contact ID