> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UKG Pro

> How to set up the UKG Pro connector, plus the actions that are available.

![UKG Pro](https://stackone-logos.com/api/ukg-pro/filled/svg)

v3.0.2[See changelog](https://docs.stackone.com/connectors/ukg-pro/changelog.md)

[56 actions](#actions) · 2 auth methods

HRIS
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [REST API — Service Account · Connector Profile](https://docs.stackone.com/connectors/ukg-pro/guides/connector-profile/rest-api-service-account.md)
>
> Connect to UKG Pro using Service Account credentials for REST API access. Supports employee data, compensation, payroll,...

> [card] [SOAP API — Service Account · Connector Profile](https://docs.stackone.com/connectors/ukg-pro/guides/connector-profile/soap-api-service-account.md)
>
> For the SOAP web services. Needs a User API Key as well as the Customer API Key, unlike the REST method. Actions run wit...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [REST API — Service Account · Link Account](https://docs.stackone.com/connectors/ukg-pro/guides/link-account/rest-api-service-account.md)

> [card] [SOAP API — Service Account · Link Account](https://docs.stackone.com/connectors/ukg-pro/guides/link-account/soap-api-service-account.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

REST API — Service Account

SOAP API — Service Account

No auth methods found

Scopes

Select all
|
Clear

CompanyConfigurationIntegration:Add

CompanyConfigurationIntegration:View

EmployeeCompensationDetails:View

EmployeeContacts:View

EmployeeDirectDeposit:View

EmployeeExport:View

EmployeeJobDetails:View

EmployeePayStatement:View

EmployeePersonDetails:View

EmployeeUserDefinedFields:View

GlobalEmployeeDirectDeposit:View

PTOPlanIntegration:Add

PTOPlanIntegration:Edit

PTOPlanIntegration:View

PayrollIntegration:View

PersonnelIntegration:View

No scopes found

56 actions

ActionDescriptionRequired scopes

List Person Details`ukg-pro_list_person_details`

Retrieve a paginated list of person details from UKG Pro REST API

`EmployeePersonDetails:View`

Get Person Details`ukg-pro_get_person_details`

Retrieve details for a specific person by employee ID from UKG Pro REST API

`EmployeePersonDetails:View`

List Employee Supervisor Details`ukg-pro_list_employee_supervisors`

Retrieve employee-supervisor relationships and reporting hierarchy from UKG Pro REST API

`PersonnelIntegration:View`

List Employee Multiple Phone Numbers`ukg-pro_list_employee_phone_numbers`

Retrieve employee phone numbers and contact information from UKG Pro REST API

`PersonnelIntegration:View`

List Employee Changes By Date`ukg-pro_list_changes_by_date`

Retrieve employee information changes within a specified date range from UKG Pro

`EmployeeExport:View`

List Employee Changes By Employee ID`ukg-pro_list_changes_by_employee`

Retrieve employee information changes for a specific employee from UKG Pro

`EmployeeExport:View`

List Business Structure Changes`ukg-pro_list_business_structure_changes`

Retrieve a list of employees with business structure changes from UKG Pro

`PersonnelIntegration:View`

List Compensation Details`ukg-pro_list_compensation_details`

Retrieve a paginated list of employee compensation details from UKG Pro REST API

`EmployeeCompensationDetails:View`

Get Compensation Details By Employee`ukg-pro_get_compensation_details`

Retrieve compensation details for a specific employee by their ID

`EmployeeCompensationDetails:View`

List Employee Job History Details`ukg-pro_list_job_history_details`

Retrieve employee job history including position changes, promotions, and salary adjustments

`PersonnelIntegration:View`

List Earnings History`ukg-pro_list_earnings_history`

Retrieve historical earnings data including base elements and pay history from UKG Pro

`PayrollIntegration:View`

List Direct Deposits`ukg-pro_list_direct_deposits`

Retrieve direct deposit details for US and Canadian employees from UKG Pro

`EmployeeDirectDeposit:View`

List Payroll Deductions History`ukg-pro_list_deductions_history`

Retrieve payroll deductions history from UKG Pro

`PayrollIntegration:View`

List Pay Group Pay Periods`ukg-pro_list_pay_periods`

Retrieve pay group and pay period information from UKG Pro

`PayrollIntegration:View`

Get Pay Register`ukg-pro_get_pay_register`

Retrieve pay register data from UKG Pro

`PayrollIntegration:View`

Get Employee Pay Statements`ukg-pro_get_employee_pay_statements`

Retrieve pay statements for a specific employee within a date range from UKG Pro

`EmployeePayStatement:View`

Get Employee Last Pay Statement`ukg-pro_get_employee_last_pay_statement`

Retrieve the most recent pay statement for a specific employee from UKG Pro

`EmployeePayStatement:View`

List Employee Deductions`ukg-pro_list_employee_deductions`

Retrieve employee benefit deduction information from UKG Pro

`PersonnelIntegration:View`

List Dependent Deductions`ukg-pro_list_dependent_deductions`

Retrieve dependent benefit deduction information from UKG Pro

`PersonnelIntegration:View`

List Employee COBRA Details`ukg-pro_list_cobra_details`

Retrieve COBRA status and details for employees from UKG Pro

`PersonnelIntegration:View`

List Open Enrollment Employee Deductions`ukg-pro_list_open_enrollment_deductions`

Retrieve open enrollment employee deduction selections from UKG Pro

`PersonnelIntegration:View`

List PTO Plans`ukg-pro_list_pto_plans`

Retrieve a paginated list of all PTO plans from UKG Pro

`PTOPlanIntegration:View`

Create PTO Plan`ukg-pro_create_pto_plan`

Create a new PTO plan record for an employee in UKG Pro

`PTOPlanIntegration:Add`

Get PTO Plan`ukg-pro_get_pto_plan`

Retrieve a specific PTO plan for an employee from UKG Pro

`PTOPlanIntegration:View`

Update PTO Plan`ukg-pro_update_pto_plan`

Update an existing PTO plan for an employee in UKG Pro

`PTOPlanIntegration:Edit`

List Employee PTO Plans`ukg-pro_list_employee_pto_plans`

Retrieve all PTO plans for a specific employee from UKG Pro

`PTOPlanIntegration:View`

List Earnings Configurations`ukg-pro_list_earnings_configurations`

Retrieve a list of all earnings type configurations from UKG Pro

`CompanyConfigurationIntegration:View`

List Organization Levels`ukg-pro_list_org_levels`

Retrieve a list of all organization level configurations from UKG Pro

`CompanyConfigurationIntegration:View`

Create Organization Level`ukg-pro_create_org_level`

Create a new organization level configuration in UKG Pro

`CompanyConfigurationIntegration:Add`

List Company Details`ukg-pro_list_companies`

Retrieve a list of all company configurations from UKG Pro

`CompanyConfigurationIntegration:View`

List Job Configurations`ukg-pro_list_job_configurations`

Retrieve a list of all job configurations from UKG Pro

`CompanyConfigurationIntegration:View`

Get Job Configuration`ukg-pro_get_job_configuration`

Retrieve a specific job configuration from UKG Pro by job code

`CompanyConfigurationIntegration:View`

List Employee Positions`ukg-pro_list_positions`

Retrieve a list of employee position information with various filtering options

`CompanyConfigurationIntegration:View`

List Location Configurations`ukg-pro_list_location_configurations`

Retrieve a list of all location configurations from UKG Pro

`CompanyConfigurationIntegration:View`

Get Location Configuration`ukg-pro_get_location_configuration`

Retrieve a specific location configuration from UKG Pro by location code

`CompanyConfigurationIntegration:View`

List Job Groups`ukg-pro_list_job_groups`

Retrieve a list of all job group configurations from UKG Pro

`CompanyConfigurationIntegration:View`

List Employee Contacts`ukg-pro_list_contacts`

Retrieve a list of all employee contacts from UKG Pro

`PersonnelIntegration:View`

Get Employee Contact Details`ukg-pro_get_contact`

Retrieve detailed information for a specific employee contact from UKG Pro

`PersonnelIntegration:View`

List International Employees`ukg-pro_list_international_employees`

Retrieve international employee details for all employees

`PersonnelIntegration:View`

Get International Employee Details`ukg-pro_get_international_employee`

Retrieve international details for a specific employee

`PersonnelIntegration:View`

List Global Employee Bank Accounts`ukg-pro_list_global_employee_banks`

Retrieve direct deposit details for global employees

`GlobalEmployeeDirectDeposit:View`

List Global Localization Elements`ukg-pro_list_global_localization_elements`

Retrieve global employee localization fields added to UKG Pro

`PersonnelIntegration:View`

Get User Details`ukg-pro_get_user_details`

Retrieve user details from UKG Pro including login information and user status

`PersonnelIntegration:View`

Get Security Roles`ukg-pro_get_security_roles`

Retrieve security roles from the roles table in UKG Pro

`CompanyConfigurationIntegration:View`

Get Employee Security User Details`ukg-pro_get_employee_security_user_details`

Retrieve employee security user details from UKG Pro

`PersonnelIntegration:View`

Find People`ukg-pro_find_person`

Search for employees based on various criteria such as name, employee number, status, location, and more

`EmployeePersonDetails:View`

Get Person By Employee Identifier`ukg-pro_get_person_by_employee_identifier`

Retrieve an individual employee's person record using their employee identifier

`EmployeePersonDetails:View`

Find User Defined Fields`ukg-pro_find_user_defined_fields`

Search for employee user-defined fields based on various criteria such as name, employee number, status, location, and m...

`EmployeeUserDefinedFields:View`

Get User Defined Fields By Employee Identifier`ukg-pro_get_user_defined_fields_by_employee_identifier`

Retrieve custom user-defined fields for a specific employee using their employee identifier

`EmployeeUserDefinedFields:View`

Find Jobs`ukg-pro_find_jobs`

Search for employee job records based on various criteria such as name, employee number, status, location, and more

`EmployeeJobDetails:View`

Get Job By Employee Identifier`ukg-pro_get_job_by_employee_identifier`

Retrieve an individual employee's job record using their employee identifier

`EmployeeJobDetails:View`

Find Compensations`ukg-pro_find_compensations`

Search for employee compensation records based on various criteria such as name, employee number, status, location, and...

`EmployeeCompensationDetails:View`

Get Compensation By Employee Identifier`ukg-pro_get_compensation_by_employee_identifier`

Retrieve an individual employee's compensation record using their employee identifier

`EmployeeCompensationDetails:View`

Find Contacts`ukg-pro_find_contacts`

Search for employee contact records based on various criteria such as name, employee number, status, location, and more

`EmployeeContacts:View`

Get Contact By Employee Identifier`ukg-pro_get_contact_by_employee_identifier`

Retrieve all contact records for an employee using their employee identifier (returns multiple contacts as an array)

`EmployeeContacts:View`

Get Employee Contact By Contact ID`ukg-pro_get_employee_contact_by_contact_id`

Retrieve a specific contact record using the contact ID

`EmployeeContacts:View`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.