> ## 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 Ready

> How to set up the UKG Ready connector, plus the actions and events that are available.

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

v2.0.3[See changelog](https://docs.stackone.com/connectors/ukg-ready/changelog.md)

[163 actions](#actions) · [1 event](#events) · 1 auth method

HRIS
ATS

## 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] [OAuth - Client Credentials Grant · Connector Profile](https://docs.stackone.com/connectors/ukg-ready/guides/connector-profile/oauth-client-credentials-grant.md)
>
> Uses a Machine to Machine OAuth application created in UKG Ready. Access is limited to the permissions of the Security P...

Optionally, configure receiving Events for UKG Ready into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/ukg-ready/guides/webhook-setup.md)

**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] [OAuth - Client Credentials Grant · Link Account](https://docs.stackone.com/connectors/ukg-ready/guides/link-account/oauth-client-credentials-grant.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

163 actions

ActionDescription

List Benefits`ukg-ready_list_benefits`

Retrieve benefit plans for all employees

Get Benefit`ukg-ready_get_benefit`

Retrieve a specific employee benefit enrollment by its enrollment ID

List Benefit Plans`ukg-ready_list_benefit_plans`

Retrieve detailed benefit plan list

List Additional Compensation`ukg-ready_list_additional_compensation`

Retrieve additional compensation records for all subordinates

Get Additional Compensation`ukg-ready_get_additional_compensation`

Retrieve detailed information about a specific additional compensation record

List Compensation History`ukg-ready_list_compensation_history`

Retrieve base compensation history for all subordinates

List Total Compensation`ukg-ready_list_total_compensation`

Retrieve total compensation information for all subordinates

Create Employee Base Compensation`ukg-ready_create_employee_base_compensation`

Create a base compensation (salary/pay rate) record for an employee

Update Employee Base Compensation`ukg-ready_update_employee_base_compensation`

Update an existing base compensation (salary/pay rate) record for an employee

Delete Employee Base Compensation`ukg-ready_delete_employee_base_compensation`

Delete a base compensation (salary/pay rate) record for an employee

Create Employee Contracts`ukg-ready_create_employee_contracts`

Create employee contracts with working hours and schedule details

Update Employee Contracts`ukg-ready_update_employee_contracts`

Update existing employee contracts

Delete Employee Contracts`ukg-ready_delete_employee_contracts`

Delete multiple employee contracts by their IDs

List Employees`ukg-ready_list_employees`

Retrieve a list of all employees for the company from UKG Ready

Get Employee`ukg-ready_get_employee`

Retrieve detailed information for a specific employee by account ID

Get Current Employee`ukg-ready_get_current_employee`

Retrieve information for the currently authenticated employee

List Changed Employees`ukg-ready_list_changed_employees`

Retrieve a list of employees with recent changes or modifications

Get Current Employee Currency`ukg-ready_get_current_employee_currency`

Retrieve currency preference for the currently authenticated employee

Get Employee Accrual Balances (v1)`ukg-ready_get_employee_accrual_balances_v1`

Retrieve accrual balance information for an employee (version 1.0)

Get Employee Accrual Balances (v2)`ukg-ready_get_employee_accrual_balances_v2`

Retrieve accrual balance information for an employee (version 2.0)

List Employee Announcements`ukg-ready_list_employee_announcements`

Retrieve announcements for a specific employee

List Employee Attendance Records`ukg-ready_list_employee_attendance_records`

Retrieve attendance records for a specific employee

List Employee Badges`ukg-ready_list_employee_badges`

Retrieve badge information for a specific employee

List Employee Benefits`ukg-ready_list_employee_benefits`

Retrieve benefit enrollments for a specific employee

List Employee Additional Compensation`ukg-ready_list_employee_additional_compensation`

Retrieve additional compensation records for a specific employee

List Employee Compensation History`ukg-ready_list_employee_compensation_history`

Retrieve compensation history for a specific employee

Get Employee Total Compensation`ukg-ready_get_employee_total_compensation`

Retrieve total compensation summary for a specific employee

List Employee Contacts`ukg-ready_list_employee_contacts`

Retrieve emergency contacts for a specific employee

List Employee Counter Adjustments`ukg-ready_list_employee_counter_adjustments`

Retrieve counter adjustments for a specific employee

List Employee Credentials`ukg-ready_list_employee_credentials`

Retrieve professional credentials for a specific employee

List Employee Deductions`ukg-ready_list_employee_deductions`

Retrieve payroll deductions for a specific employee

Get Employee Demographics`ukg-ready_get_employee_demographics`

Retrieve demographic information for a specific employee

List Employee Direct Deposits`ukg-ready_list_employee_direct_deposits`

Retrieve direct deposit information for a specific employee

List Employee Documents`ukg-ready_list_employee_documents`

Retrieve documents for a specific employee

List Employee Custom Forms`ukg-ready_list_employee_custom_forms`

Retrieve custom form data for a specific employee

List Employee Pay Forms`ukg-ready_list_employee_pay_forms`

Retrieve pay form data for a specific employee

List Employee System Forms`ukg-ready_list_employee_system_forms`

Retrieve system form data for a specific employee

List Employee Holidays`ukg-ready_list_employee_holidays`

Retrieve holiday schedule for a specific employee

List Employee HR Custom Fields`ukg-ready_list_employee_hr_custom_fields`

Retrieve HR custom field data for a specific employee

List Employee LOA Cases`ukg-ready_list_employee_loa_cases`

Retrieve leave of absence cases for a specific employee

List Employee LOA Counters`ukg-ready_list_employee_loa_counters`

Retrieve leave of absence counter balances for a specific employee

List Employee LOA Requests`ukg-ready_list_employee_loa_requests`

Retrieve leave of absence requests for a specific employee

List Employee Managed Cost Centers`ukg-ready_list_employee_managed_cost_centers`

Retrieve cost centers managed by a specific employee

Create Employee Managed Cost Center`ukg-ready_create_employee_managed_cost_center`

Create a managed cost center for an employee

List Employee Manager Replacements`ukg-ready_list_employee_manager_replacements`

Retrieve manager replacement configurations for a specific employee

List Employee Mailbox Notifications`ukg-ready_list_employee_mailbox_notifications`

Retrieve mailbox notifications for a specific employee

List Employee Todo Notifications`ukg-ready_list_employee_todo_notifications`

Retrieve todo item notifications for a specific employee

List Employee Overtime Requests`ukg-ready_list_employee_overtime_requests`

Retrieve overtime requests for a specific employee

Get Employee Pay Info`ukg-ready_get_employee_pay_info`

Retrieve pay information for a specific employee

Get Employee Profiles`ukg-ready_get_employee_profiles`

Retrieve profile assignments for a specific employee

List Employee Recent Punches`ukg-ready_list_employee_recent_punches`

Retrieve recent time clock punches for a specific employee

Get Employee Tax Info`ukg-ready_get_employee_tax_info`

Retrieve tax information for a specific employee

List Employee Time Entries`ukg-ready_list_employee_time_entries`

Retrieve time entries for a specific employee

List Employee Timesheets`ukg-ready_list_employee_timesheets`

Retrieve timesheets for a specific employee

Get Employee Timeoff Calendar Sync`ukg-ready_get_employee_timeoff_calendar_sync`

Retrieve time-off calendar synchronization settings for a specific employee

List Employee Training`ukg-ready_list_employee_training`

Retrieve training records for a specific employee

List Employee Skills`ukg-ready_list_employee_skills`

Retrieve skills for a specific employee

Get Employee VCA Report Settings`ukg-ready_get_employee_vca_report_settings`

Retrieve VCA report settings for a specific employee

Create Employee`ukg-ready_create_employee`

Create a new employee record with required core information

Update Employee`ukg-ready_update_employee`

Update an existing employee record with new information

Delete Employee`ukg-ready_delete_employee`

Terminate or delete an employee record from the system

Create Employee Additional Compensation`ukg-ready_create_employee_additional_compensation`

Creates an additional compensation record for an employee

Set Employee Accrual Balance (V1)`ukg-ready_set_employee_accrual_balance_v1`

Sets the accrual balance for an employee using V1 accruals module

Change Employee Accrual Balance`ukg-ready_change_employee_accrual_balance`

Applies a change to an employee's remaining accrual balance

Update Employee Demographics`ukg-ready_update_employee_demographics`

Update employee demographic information

Update Employee HR Custom Fields`ukg-ready_update_employee_hr_custom_fields`

Update employee HR custom fields

Update Employee Pay Info`ukg-ready_update_employee_pay_info`

Update employee pay information

Batch Update Time Entries`ukg-ready_batch_update_time_entries`

Replace or update time entries for one or more employees over a date range

Delete Time Entry`ukg-ready_delete_time_entry`

Delete a single time entry by its ID

Perform Timesheet Action`ukg-ready_timesheet_action`

Submit, approve, reject, reopen or correct a timesheet

List Time Entry Notes`ukg-ready_list_time_entry_notes`

Retrieve the notes attached to one or more time entries

Create Time Entry Notes`ukg-ready_create_time_entry_notes`

Attach one or more notes to time entries

Delete Time Entry Notes`ukg-ready_delete_time_entry_notes`

Delete one or more time entry notes by ID

List Cost Center Jobs`ukg-ready_list_cost_center_jobs`

Retrieve all cost center jobs available within the company

Create Cost Center Job`ukg-ready_create_cost_center_job`

Create a new cost center job within the company

Get Cost Center Job`ukg-ready_get_cost_center_job`

Retrieve a specific cost center job by ID

Update Cost Center Job`ukg-ready_update_cost_center_job`

Update a specific cost center job

Delete Cost Center Job`ukg-ready_delete_cost_center_job`

Delete a specific cost center job by ID

Lookup Jobs`ukg-ready_lookup_jobs`

Retrieve the list of job positions available in the organization

Lookup Groups`ukg-ready_lookup_groups`

Retrieve company or account groups from the organization by object type

Lookup Employee Types`ukg-ready_lookup_employee_types`

Retrieve the list of employee types or classifications

Lookup Pay Types`ukg-ready_lookup_pay_types`

Retrieve the list of pay types available in the organization

Lookup Job Categories`ukg-ready_lookup_job_categories`

Retrieve the list of job categories configured in the organization

Lookup Earning Codes`ukg-ready_lookup_earning_codes`

Retrieve the list of earning codes used for payroll

Lookup Deduction Codes`ukg-ready_lookup_deduction_codes`

Retrieve the list of deduction codes used for payroll

Lookup Termination Reasons`ukg-ready_lookup_termination_reasons`

Retrieve the list of termination reasons

Lookup Worker Types`ukg-ready_lookup_worker_types`

Retrieve the list of worker types

Lookup Benefit Plans`ukg-ready_lookup_benefit_plans`

Retrieve the list of benefit plans available to employees

Lookup Pay Grades`ukg-ready_lookup_pay_grades`

Retrieve the list of pay grades or compensation levels

Lookup Skills`ukg-ready_lookup_skills`

Retrieve the list of skills tracked in the organization

Lookup Job Change Reasons`ukg-ready_lookup_job_change_reasons`

Retrieve the list of reasons for job or position changes

Lookup Timezones`ukg-ready_lookup_timezones`

Retrieve the list of timezones available in UKG Ready

Lookup Locales`ukg-ready_lookup_locales`

Retrieve the list of locales or language preferences

Lookup Additional Compensation Types`ukg-ready_lookup_additional_compensation_types`

Retrieve the list of additional compensation types

Lookup Benefit Types`ukg-ready_lookup_benefit_types`

Retrieve the list of benefit types

Lookup Document Types`ukg-ready_lookup_document_types`

Retrieve the list of document types

Lookup EINs`ukg-ready_lookup_eins`

Retrieve the list of Employer Identification Numbers

Lookup Hiring Stages`ukg-ready_lookup_hiring_stages`

Retrieve the list of hiring stages

Lookup Job Application Status`ukg-ready_lookup_job_application_status`

Retrieve the list of job application statuses

Lookup Credential Types`ukg-ready_lookup_credential_types`

Retrieve the list of credential types

Lookup Job Requisition Categories`ukg-ready_lookup_job_req_job_categories`

Retrieve the list of job requisition categories

Lookup Job Requisition Locations`ukg-ready_lookup_job_req_job_locations`

Retrieve the list of job requisition locations

Lookup Eye Colors`ukg-ready_lookup_eye_color`

Retrieve the list of eye color options

Lookup LOA Reasons`ukg-ready_lookup_loa_reasons`

Retrieve the list of leave of absence reasons

Lookup Overtime Reasons`ukg-ready_lookup_overtime_reasons`

Retrieve the list of overtime reasons

Lookup Pay Categories`ukg-ready_lookup_pay_categories`

Timesheet-scoped: returns pay categories valid for a specific employee's timesheet entry on a given date (NOT a company-...

Lookup Pay Calculation Profiles`ukg-ready_lookup_pay_cal_profiles`

Retrieve the list of pay calculation profiles

Lookup Pay Period Profiles`ukg-ready_lookup_pay_period_profiles`

Retrieve the list of pay period profiles

Lookup Pay Statement Types`ukg-ready_lookup_pay_statement_types`

Retrieve the list of pay statement types

Lookup Payroll Batch Types`ukg-ready_lookup_payroll_batch_types`

Retrieve the list of payroll batch types

Lookup Payroll Types`ukg-ready_lookup_payroll_types`

Retrieve the list of payroll types

Lookup Tax Codes`ukg-ready_lookup_tax_codes`

Retrieve the list of tax codes

Lookup Unions`ukg-ready_lookup_unions`

Retrieve the list of labor unions

Lookup Workers Compensation Codes`ukg-ready_lookup_workers_comp_codes`

Retrieve the list of workers compensation codes

Lookup Profile-Specific EINs`ukg-ready_lookup_profile_specific_eins`

Retrieve profile-specific Employer Identification Numbers

Lookup Accruals Profiles`ukg-ready_lookup_profiles_accruals`

Retrieve accrual profiles for time-off and leave management

Lookup Accrual Profiles (v1.0)`ukg-ready_lookup_profiles_accrual_profiles`

Retrieve accrual profiles (legacy endpoint)

Lookup Demographic Profiles`ukg-ready_lookup_profiles_demographic`

Retrieve demographic profiles

Lookup Leave Of Absence Profiles`ukg-ready_lookup_profiles_leave_of_absence`

Retrieve leave of absence profiles

Lookup Pay Grade Profiles`ukg-ready_lookup_profiles_pay_grades`

Retrieve pay grade profiles

Lookup Pay Period Profile Configs`ukg-ready_lookup_profiles_pay_period`

Retrieve pay period profiles

Lookup Pay Prep Profiles`ukg-ready_lookup_profiles_pay_prep`

Retrieve pay prep profiles

Lookup Time Off Planning Profiles`ukg-ready_lookup_profiles_time_off_planning`

Retrieve time off planning profiles

Lookup Premium Shifts`ukg-ready_lookup_premium_shifts`

Returns the company-wide list of defined shift premiums

Lookup Cost Centers`ukg-ready_lookup_cost_centers`

Returns the individual cost centers configured in a cost-center tree

Lookup Time Offs`ukg-ready_lookup_time_offs`

Returns the company-wide list of time-off types

Lookup Counters`ukg-ready_lookup_counters`

Returns the manual counters available to an employee on a given date

List Overtime Requests`ukg-ready_list_overtime_requests`

Retrieve overtime requests for manager's group members

Create Overtime Request`ukg-ready_create_overtime_request`

Create a new overtime request for an employee

Get Overtime Request`ukg-ready_get_overtime_request`

Retrieve a single overtime request by ID

Delete Overtime Request`ukg-ready_delete_overtime_request`

Delete an overtime request by ID

List Overtime Request Notes`ukg-ready_list_overtime_request_notes`

Retrieve notes for a specific overtime request

List Pay Period Profiles`ukg-ready_list_pay_period_profiles`

Retrieve a list of pay period profiles for the company

List Payrolls`ukg-ready_list_payrolls`

Retrieve a list of company payrolls normally accessed to process payroll

Create Payroll`ukg-ready_create_payroll`

Create a new payroll that has not been scheduled

Get Payroll`ukg-ready_get_payroll`

Get detailed information about a specific payroll

Delete Payroll`ukg-ready_delete_payroll`

Delete a specific payroll by ID

List Rate Tables`ukg-ready_list_rate_tables`

Retrieve rate tables configured for the company

Get Rate Table`ukg-ready_get_rate_table`

Retrieve a single rate table by id

Create Rate Table`ukg-ready_create_rate_table`

Create a new company rate table

Update Rate Table`ukg-ready_update_rate_table`

Update an existing company rate table

Delete Rate Table`ukg-ready_delete_rate_table`

Delete a company rate table

List Rate Table Schedules`ukg-ready_list_rate_table_schedules`

Retrieve the rate schedules (rows) of a rate table

Create Rate Table Schedule`ukg-ready_create_rate_table_schedule`

Add a rate schedule (rate row) to a rate table

Update Rate Table Schedule`ukg-ready_update_rate_table_schedule`

Update a rate schedule (rate row) within a rate table

Delete Rate Table Schedule`ukg-ready_delete_rate_table_schedule`

Delete a rate schedule (rate row) from a rate table

List Job Applications`ukg-ready_list_job_applications`

Retrieve all job applications in the company

Create Job Application`ukg-ready_create_job_application`

Create a new job application for an applicant

Get Job Application`ukg-ready_get_job_application`

Retrieve a specific job application by ID

Update Job Application`ukg-ready_update_job_application`

Update an existing job application

Delete Job Application`ukg-ready_delete_job_application`

Delete a specific job application by ID

List Job Requisitions`ukg-ready_list_job_requisitions`

Retrieve all job requisitions available within the company

Get Job Requisition`ukg-ready_get_job_requisition`

Retrieve details of a specific job requisition by ID

Get Job Requisition Questionnaire`ukg-ready_get_job_requisition_questionnaire`

Retrieve questionnaire for a specific job requisition

List Applicants`ukg-ready_list_applicants`

Retrieve all applicant accounts in the company

List Schedule Settings`ukg-ready_list_schedule_settings`

Retrieve the list of schedule settings

List Schedules`ukg-ready_list_schedules`

Retrieve a list of schedules for the company

Create Schedule`ukg-ready_create_schedule`

Create a new schedule for the company

List PTO Requests`ukg-ready_list_pto_requests`

Retrieve PTO requests for subordinate employees

Get PTO Request`ukg-ready_get_pto_request`

Retrieve information about a single PTO request

Create PTO Request`ukg-ready_create_pto_request`

Create a new PTO request for an employee

Delete PTO Request`ukg-ready_delete_pto_request`

Delete one or more PTO requests

List PTO Request Notes`ukg-ready_list_pto_request_notes`

Retrieve all notes for a PTO request

## Events

Tags

Select all
|
Clear

Webhooks

No tags found

1 event

EventDescriptionTags

UKG Ready Webhook Event`ukg-ready_webhook_event`

Processes inbound UKG Ready webhook subscription events (account and employee record changes, applicants, timesheets, ti...

Webhooks


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