Integration

UKG Pro HCM integration

UKG Pro HCM (formerly UltiPro) is UKG's human capital management suite. Read employee person, employment, compensation, job history, contacts, deductions, benefits, COBRA, PTO and user records; read payroll data (pay statements, pay register, earnings and deduction history, general ledger runs, pay periods); read company configuration (companies, jobs, positions, locations, org levels, code tables, earning codes, rates, roles); and write org levels, PTO plans, accruals, imported earnings and pending pay items that feed the next payroll. Social security and national id numbers, I-9 alien and document numbers, the company federal tax id and bank account numbers are stripped from every response, and the direct deposit, global bank, national document, import tool (file and XML), Time and Attendance (UTA), code table write and deprecated v1 job routes are not exposed; Recruiting, Onboarding and Learning use another credential and are a separate API. Authentication: a UKG Pro web service account (created under System Configuration, Security, Service Account Administration, with View, Add, Edit or Delete roles per web service). Enter the Base64 encoding of username:password (sent after Basic), the Customer API Key from System Configuration, Security, Web Services, and the service host of your tenant (for example servicet.ultipro.com; it varies by data center and environment).

Ask it in chat

Say what should happen.
The workflow builds itself.

When this happens, do that in UKG Pro HCM.Built from the 131 UKG Pro HCM tools below, on the connection you add once.

What you can do with UKG Pro HCM

Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.

Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.

Code table, 24 operations

  • list_allergy_codesList allergy codesGETLists the allergy codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_award_type_codesList award type codesGETLists the award type codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_career_provider_codesList career provider codesGETLists the career provider codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_child_support_type_codesList child support type codesGETLists the child support type codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_cobra_status_codesList cobra status codesGETLists the COBRA status codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_code_tablesList code tablesGETLists every UKG Pro code table with a link to read its codes; the common tables also have their own listing tool (for example list_marital_status_codes). Needs the View role on the Company Configuration Integration web service.
  • list_company_property_codesList company property codesGETLists the company property codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_course_category_codesList course category codesGETLists the course category codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_course_delivery_met_codesList course delivery met codesGETLists the course delivery method codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_course_sub_category_codesList course sub category codesGETLists the course subcategory codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_disability_codesList disability codesGETLists the disability codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_employee_type_codesList employee type codesGETLists the employee type codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_job_family_codesList job family codesGETLists the job family codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_license_type_codesList license type codesGETLists the license type codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_loan_type_codesList loan type codesGETLists the loan type codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_marital_status_codesList marital status codesGETLists the marital status codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_military_branches_codesList military branches codesGETLists the military branch codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_military_era_codesList military era codesGETLists the military era codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_name_prefix_codesList name prefix codesGETLists the name prefix codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_other_phone_types_codesList other phone types codesGETLists the other phone type codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_project_codesList project codesGETLists the project codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_school_codesList school codesGETLists the school codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_skill_proficiency_level_codesList skill proficiency level codesGETLists the skill proficiency level codes configured in UKG Pro (code and description), used to read or validate coded employee fields.
  • list_skills_codesList skills codesGETLists the skill codes configured in UKG Pro (code and description), used to read or validate coded employee fields.

Pending pay item, 8 operations

  • create_pending_deductionCreate pending deductionPOSTCreates a deduction pending pay item for an employee, deducted in the payroll of scheduledPayDate. Flat Amount deductions only; no workflow or approvers run. Needs the Add role on the Payroll Integration web service.
  • create_pending_earningCreate pending earningPOSTCreates an earnings pending pay item for an employee, paid in the payroll of scheduledPayDate. Flat amount or hours-based earnings only; no workflow or approvers run. Needs the Add role on the Payroll Integration web service.
  • delete_pending_deductionDelete pending deductionDELETEMarks a deduction pending pay item Deleted; only items still Pending or Submitted can be deleted. Needs the Delete role on the Payroll Integration web service.
  • delete_pending_earningDelete pending earningDELETEMarks an earnings pending pay item Deleted; only items still Pending or Submitted can be deleted. Needs the Delete role on the Payroll Integration web service.
  • get_pending_deductionGet pending deductionGETReturns one deduction pending pay item by its id. Needs the View role on the Payroll Integration web service.
  • get_pending_earningGet pending earningGETReturns one earnings pending pay item by its id. Needs the View role on the Payroll Integration web service.
  • list_pending_deductionsList pending deductionsGETReturns deduction pending pay items by the sourceKey given when they were created. Needs the View role on the Payroll Integration web service.
  • list_pending_earningsList pending earningsGETReturns earnings pending pay items by the sourceKey given when they were created. Needs the View role on the Payroll Integration web service.

Pay statement, 5 operations

  • get_pay_statementGet pay statementGETReturns zero or one pay statement by its pay identifier (from a pay statement listing). Bank account numbers are not exposed. Needs the View role on the Employee Pay Statements web service.
  • list_company_pay_statementsList company pay statementsPOSTReturns full pay statements of a company for pay dates between startDate and endDate, optionally for one pay group or company. A read; bank account numbers are not exposed. Needs the View role on the Employee Pay Statements web service.
  • list_company_pay_statement_summariesList company pay statement summariesPOSTReturns pay statement summaries (total earnings, deductions, taxes) for pay dates between startDate and endDate, optionally for one pay group or company. A read. Needs the View role on the Employee Pay Statements web service.
  • list_employee_pay_statementsList employee pay statementsPOSTReturns the pay statements of one employee (employeeIdentifier) between startDate and endDate. A read; bank account numbers are not exposed. Needs the View role on the Employee Pay Statements web service.
  • list_employee_pay_statements_by_identifierList employee pay statements by identifierPOSTReturns pay statements for one employee, identified by employeeIdentifier, optionally between startDate and endDate. A read; bank account numbers are not exposed. Needs the View role on the Employee Pay Statements web service.

Compensation, 4 operations

  • get_employee_compensationGet employee compensationGETReturns the compensation details of one employee. Needs the View role on the Employee Compensation Details web service.
  • get_employee_compensation_in_companyGet employee compensation in companyGETReturns the compensation details of one employee in one company. Needs the View role on the Employee Compensation Details web service.
  • list_company_compensationList company compensationGETLists compensation details (pay rate, annual salary, job, pay group, dates) of a company's employees, with filters. Needs the View role on the Employee Compensation Details web service.
  • list_compensationList compensationGETLists compensation details (pay rate, annual salary, job, pay group, dates) of employees across companies, with filters. Needs the View role on the Employee Compensation Details web service.

Person, 4 operations

  • get_employee_person_in_companyGet employee person in companyGETReturns the person record (name, address, contact, demographics) of one employee in one company. National ids are not exposed. Needs the View role on the Employee Person Details web service.
  • get_personGet personGETReturns the person record of one employee. National ids are not exposed. Needs the View role on the Employee Person Details web service.
  • list_company_peopleList company peopleGETLists person records (name, address, contact, demographics) of a company's employees, with filters. National ids are not exposed. Needs the View role on the Employee Person Details web service.
  • list_peopleList peopleGETLists person records (name, address, contact, demographics) across companies, with filters. National ids are not exposed. Needs the View role on the Employee Person Details web service.

Pto plan, 4 operations

  • create_pto_plansCreate pto plansPOSTCreates one or more employee PTO plan records. No workflow or approvers run. Needs the Add role on the PTO Plan Integration web service.
  • get_employee_pto_planGet employee pto planGETReturns one PTO plan of one employee with earned, taken and pending balances. Needs the View role on the PTO Plan Integration web service.
  • list_employee_pto_plansList employee pto plansGETLists the PTO plans of one employee with earned, taken and pending balances. Needs the View role on the PTO Plan Integration web service.
  • list_pto_plansList pto plansGETLists employees' PTO plans with earned, taken and pending balances. Needs the View role on the PTO Plan Integration web service.

Accrual, 3 operations

  • delete_accrualDelete accrualDELETEDeletes one accrual (batchId and sourceId) from the accruals staging table.
  • delete_accrual_batchDelete accrual batchDELETEDeletes every accrual of a batch from the accruals staging table.
  • import_accrualsImport accrualsPOSTImports accrual balances (code, description, taken, balance, unit) into the UKG Pro accruals staging table; they can print on pay statements.

Custom field, 3 operations

  • get_custom_fields_schemaGet custom fields schemaGETReturns the schema of the Platform Configuration custom fields added to standard classes, optionally for one className. Needs the View role on the Company Configuration Integration web service.
  • get_custom_field_valuesGet custom field valuesGETReturns Platform Configuration custom field values of one class (Address, Person, Employee, Employment, Job, Location, OrgLevel1-4...). Needs the View role on the Personnel Integration web service.
  • get_custom_field_values_v2Get custom field values v2GETLike get_custom_field_values but filterable by keyValue (an employee id, a job or location code...); also supports the Contacts class. Needs the View role on the Personnel Integration web service.

Earning code, 3 operations

  • filter_earning_codesFilter earning codesGETLists earning configurations matching all six path filters (calculation rule, tax category, deduction offset, country, shift differential, manual check). Paged with page and per_Page.
  • get_earning_codeGet earning codeGETReturns the configuration of one earning code.
  • list_earning_codesList earning codesGETLists the company-level earnings configuration (earning codes with calculation rule, tax category and inclusion flags), filterable by those settings. Paged with page and per_Page.

Earning import, 3 operations

  • delete_imported_earningDelete imported earningDELETEDeletes an imported earning not yet processed in payroll; a processed earning cannot be deleted. Needs the Delete role on the Payroll Integration web service.
  • get_imported_earningGet imported earningGETReturns an earning previously sent with import_earnings, by its refId. Needs the Get role on the Payroll Integration web service.
  • import_earningsImport earningsPOSTSends earnings to UKG Pro Payroll for the next payroll (they are paid when payroll runs). Delete with delete_imported_earning before payroll processes them. Needs the Add role on the Payroll Integration web service.

Employment, 3 operations

  • get_employee_employment_in_companyGet employee employment in companyGETReturns the employment record (job, status, hire and termination dates, supervisor, org levels) of one employee in one company. Needs the View role on the Personnel Integration web service.
  • list_company_employmentList company employmentGETLists employment records (job, status, hire and termination dates, supervisor, org levels) of a company's employees, with filters. Needs the View role on the Personnel Integration web service.
  • list_employmentList employmentGETLists employment records (job, status, hire and termination dates, supervisor, org levels) across companies, with filters. Needs the View role on the Personnel Integration web service.

Kronos integration, 3 operations

  • list_kronos_business_structure_statusList kronos business structure statusGETLists business structure status records for the UKG Dimensions or Workforce Central integration, modified after a date, for a company. Needs the View role on the Personnel Integration web service.
  • list_kronos_employee_profilesList kronos employee profilesGETLists employee profiles prepared for the UKG Dimensions or Workforce Central integration, for a product code, optionally for given companies and employees. Needs the View role on the Personnel Integration web service.
  • list_kronos_employee_statusList kronos employee statusGETLists employee status records for the UKG Dimensions or Workforce Central integration, as of an effective date. Needs the View role on the Personnel Integration web service.

Org level, 3 operations

  • create_org_levelsCreate org levelsPOSTCreates one or more organization level configurations. Needs the Add role on the Company Configuration Integration web service.
  • get_org_levelGet org levelGETReturns one organization level configuration; it is identified by level and code together. Needs the View role on the Company Configuration Integration web service.
  • list_org_levelsList org levelsGETLists organization level configurations (levels 1 to 4 with code, description, budget and GL segment). Needs the View role on the Company Configuration Integration web service.

Audit, 2 operations

  • list_audit_detailsList audit detailsGETLists field-level audit records (old and new values) for one table and field between startDateTime and endDateTime; tables and fields come from list_integration_audit_configuration. Needs the View role on the Personnel Integration web service.
  • list_integration_audit_configurationList integration audit configurationGETLists the tables and fields that are audited, to use with list_audit_details. Needs the View role on the Personnel Integration web service.

Contact, 2 operations

  • get_contactGet contactGETReturns one person recorded as an employee contact. National ids are not exposed. Needs the View role on the Personnel Integration web service.
  • list_contactsList contactsGETLists people recorded as an employee's contacts (dependents, beneficiaries, emergency contacts), with filters. National ids are not exposed. Needs the View role on the Personnel Integration web service.

Deduction history, 2 operations

  • list_deduction_change_datesList deduction change datesGETLists the effective dates on which one deduction field (fieldName) changed for the given deduction codes, optionally per company and as of sessionDate. Needs the View role on the Personnel Integration web service.
  • list_payroll_deduction_historyList payroll deduction historyGETLists deduction history lines from processed payrolls, filterable by employee, company, check, deduction code or type, plan flags, pay group and pay date. Needs the View role on the Payroll Integration web service.

Employee change, 2 operations

  • get_employee_changesGet employee changesGETReturns one employee's record as of the latest change window (3-hour minimum); compare with a previous call to see what changed. Needs the View role on the EmployeeExport web service.
  • list_employee_changesList employee changesGETReturns employee records changed in a time window (3-hour minimum); call it at most 8 times a day and compare with the previous result to see what changed. Needs the View role on the EmployeeExport web service.

Employee deduction, 2 operations

  • list_benefit_option_change_datesList benefit option change datesGETLists the dates employees' benefit options changed, filterable by company, deduction code and effective date. Needs the View role on the Personnel Integration web service.
  • list_employee_deductionsList employee deductionsGETLists employees' benefit and deduction elections for one or more deduction codes (dedCode), filterable by employee, company, benefit status and option. Needs the View role on the Personnel Integration web service.

Employee element, 2 operations

  • list_employee_extended_elementsList employee extended elementsGETLists extended employee elements (I-9, visa, disability and other extended fields), filterable by company, employee and created or changed dates. Needs the View role on the Personnel Integration web service.
  • list_employee_localization_elementsList employee localization elementsGETLists global employee localization fields (Platform Configuration fields prefixed GBLPay), filterable by employee, company, created and effective dates. Needs the View role on the Personnel Integration web service.

General ledger, 2 operations

  • get_general_ledger_runGet general ledger runGETReturns the details of one general ledger run, filterable by blockId. Paged with page and per_Page.
  • list_general_ledger_runsList general ledger runsGETLists general ledger run details, filterable by runId and blockId, or the most recent run. Paged with page and per_Page.

International employee, 2 operations

  • get_international_employeeGet international employeeGETReturns one employee's international details. National ids are not exposed. Needs the View role on the Personnel Integration web service.
  • list_international_employeesList international employeesGETLists international employee details (country-specific fields), filterable by country, effective date and employee. National ids are not exposed. Needs the View role on the Personnel Integration web service.

Job, 2 operations

  • get_jobGet jobGETReturns one job configuration by its job code. Needs the View role on the Company Configuration Integration web service.
  • list_jobsList jobsGETLists job configurations (job code, title, family, pay grade...), filterable by job code, country and active flag. Needs the View role on the Company Configuration Integration web service.

Job history, 2 operations

  • get_job_history_recordGet job history recordGETReturns one job history record by its systemId. Needs the View role on the Employee Job History Details web service.
  • list_job_historyList job historyGETLists employee job history records (org, job, rate changes and promotions), filterable by company, employee, change type and dates. Needs the View role on the Employee Job History Details web service.

Open enrollment, 2 operations

  • list_open_enrollment_dependent_deductionsList open enrollment dependent deductionsGETLists dependents' open enrollment deduction elections for deduction codes, a session type and a date range. Needs the View role on the Personnel Integration web service.
  • list_open_enrollment_employee_deductionsList open enrollment employee deductionsGETLists employees' open enrollment deduction elections for deduction codes, a session type and a date range. Needs the View role on the Personnel Integration web service.

Position, 2 operations

  • list_position_reportList position reportGETLists the position reporting structure (position and the position it reports to) with effective dates. Needs the View role on the Personnel Integration web service.
  • list_positionsList positionsGETLists positions, filterable by company, employee type, status, pay group, position, project, shift group and flags (several codes comma-separated). Needs the View role on the Company Configuration Integration web service.

User defined field, 2 operations

  • get_employee_user_defined_fieldsGet employee user defined fieldsGETReturns the user-defined field values of one employee in one company. Needs the View role on the Personnel Integration web service.
  • list_company_user_defined_fieldsList company user defined fieldsGETLists the user-defined field values of a company's employees. Needs the View role on the Personnel Integration web service.

Cobra, 1 operation

  • list_employee_cobraList employee cobraGETLists employees' COBRA continuation details, filterable by company, employee, status and event date. Needs the View role on the Personnel Integration web service.

Company, 1 operation

  • list_companiesList companiesGETLists the master and component companies: ids, codes, names, addresses, phones (no federal tax id). Filter by companyId, masterCompanyId, companyCode. Needs the View role on the Company Configuration Integration web service.

Demographics, 1 operation

  • list_employee_demographicsList employee demographicsGETLists employee demographic details (name, address, ethnicity, gender, nationality...), filterable by employee, company, name, email and address. National ids are not exposed. Needs the View role on the Personnel Integration web service.

Dependent deduction, 1 operation

  • list_dependent_deductionsList dependent deductionsGETLists dependents' benefit deductions, filterable by company, contact, deduction code, employee and effective date. Needs the View role on the Personnel Integration web service.

Earnings history, 1 operation

  • list_earnings_historyList earnings historyGETLists earnings history lines (by pay date, earning code and employee), filterable by company, employee, pay group and period control. Needs the View role on the Payroll Integration web service.

Education, 1 operation

  • list_employee_educationList employee educationGETLists employee education records, filterable by systemId, employee and country. Needs the View role on the Personnel Integration web service.

Employee job, 1 operation

  • list_employee_jobsList employee jobsGETLists the jobs held by employees with several jobs, filterable by employee, company, job code and primary or inactive flags. Needs the View role on the Personnel Integration web service.

Employee position, 1 operation

  • list_employee_positionsList employee positionsGETLists the positions held by employees with several positions, filterable by employee, company, job, position and primary flag. Needs the View role on the Personnel Integration web service.

Employment contract, 1 operation

  • list_employee_contractsList employee contractsGETLists employment contract details, filterable by company, employee, contract number and type, effective and created dates. Needs the View role on the Personnel Integration web service.

Insurance rate, 1 operation

  • list_insurance_ratesList insurance ratesGETLists insurance rates by deduction code and pay frequency, as of effectiveDate (today when left out). Needs the View role on the Company Configuration Integration web service.

Job group, 1 operation

  • list_job_groupsList job groupsGETLists job groups, filterable by job group code and country. Needs the View role on the Company Configuration Integration web service.

Location, 1 operation

  • list_locationsList locationsGETLists work location configurations, filterable by country and active flag. Needs the View role on the Company Configuration Integration web service.

Option rate, 1 operation

  • list_benefit_option_ratesList benefit option ratesGETLists benefit option rates by deduction code, benefit option and pay frequency, as of effectiveDate (today when left out). Needs the View role on the Company Configuration Integration web service.

Pay detail, 1 operation

  • list_company_pay_detailsList company pay detailsPOSTReturns finalized pay details (earnings, deductions, taxes per pay) of a company for pay periods between startDate and endDate, optionally one pay group or period. A read. Needs the View role on the Employee Pay Statements web service.

Pay element, 1 operation

  • list_employee_pay_deduction_elementsList employee pay deduction elementsGETLists global employee payments and deductions, filterable by company, employee, country, pay group, element name, payment or deduction, and dates. Needs the View role on the Personnel Integration web service.

Pay period, 1 operation

  • list_pay_group_periodsList pay group periodsGETLists pay group pay periods with pay dates and period start and end dates, filterable by pay group, dates and period control. Needs the View role on the Payroll Integration web service.

Pay register, 1 operation

  • list_pay_registerList pay registerGETLists pay register lines (checks per employee and pay date), filterable by employee, company, check, document number, pay group and period. Needs the View role on the Payroll Integration web service.

Phone number, 1 operation

  • list_employee_phone_numbersList employee phone numbersGETLists employees' additional phone numbers, filterable by employee and systemId. Needs the View role on the Personnel Integration web service.

Reporting category, 1 operation

  • list_org_reporting_categoriesList org reporting categoriesGETLists organization reporting categories. Needs the View role on the Company Configuration Integration web service.

Role, 1 operation

  • list_rolesList rolesGETLists UKG Pro security roles, filterable by role name. Needs the View role on the Company Configuration Integration web service.

Shift code, 1 operation

  • list_shift_codesList shift codesGETLists shift code configurations. Needs the View role on the Company Configuration Integration web service.

Supervisor, 1 operation

  • list_employee_supervisorsList employee supervisorsGETLists each employee's supervisor, filterable by employee, company and supervisor ids. Needs the View role on the Personnel Integration web service.

Tax group, 1 operation

  • list_tax_groupsList tax groupsGETLists tax calculation groups, filterable by taxCalcGroupIdCode (several comma-separated) and inactive flag. Needs the View role on the Company Configuration Integration web service.

User, 1 operation

  • list_employee_user_accountsList employee user accountsGETLists the UKG Pro user accounts linked to employees, filterable by user name and employee id. Needs the View role on the Personnel Integration web service.

Showing the first 120 of 131 endpoints. The rest are in the product, searchable from the workflow builder and from chat.

Use UKG Pro HCM from Claude Code, Cursor or Codex

Connect UKG Pro HCM in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its UKG Pro HCM operations become tools the client can call, next to every other integration you connected.

Claude Code
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"
Codex (~/.codex/config.toml)
[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"

[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"
Cursor, Claude Desktop and other JSON configs
{
  "mcpServers": {
    "livecontext": {
      "type": "http",
      "url": "https://livecontext.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Set up the MCP server step by step

How to connect UKG Pro HCM

  1. Create your workspace

    Sign up free. Nothing to install.

  2. Connect UKG Pro HCM once

    Add your UKG Pro HCM connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.

  3. Describe the job in chat

    The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.

UKG Pro HCM integration FAQ

What can you do with the UKG Pro HCM integration?

LiveContext exposes 131 operations on UKG Pro HCM, covering code table, pending pay item, pay statement and compensation.

Popular integrations

Browse the whole catalog