UKG

UKG (Ultimate Kronos Group) is an enterprise human capital management (HCM) and workforce management platform serving over 80,000 organizations worldwide. The UKG Pro suite includes HCM APIs for employee data, payroll, benefits, and personnel actions, plus WFM APIs for time and labor management, scheduling, accruals, and attendance. The UKG Developer Hub provides REST APIs, webhook subscriptions, and People Fabric APIs for building HR integrations, payroll connectors, and workforce analytics applications.

3 APIs 8 Features

Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

APIs

UKG Pro HCM API

The UKG Pro HCM API provides programmatic access to human capital management data including employees, personnel actions, benefits, payroll, performance, and organizational stru...

UKG Pro Workforce Management API

The UKG Pro WFM API provides programmatic access to time and labor management data including punches, shifts, schedules, accruals, and attendance. Supports timekeeping, scheduli...

UKG HR Service Delivery API

The UKG HR Service Delivery API (formerly People Doc) provides access to employee request management, knowledge portal content, process automation, document storage, and complia...

Collections

UKG Pro HCM API

POSTMAN

UKG Pro Workforce Management API

POSTMAN

UKG Pro HCM API

OPEN

UKG Pro Workforce Management API

OPEN

Arazzo Workflows

UKG Pro HCM Benefits Enrollment Audit

Locate an employee and audit their active benefits elections.

ARAZZO

UKG Pro WFM Clock In and Verify

Resolve a WFM employee, submit a clock punch, and verify it landed.

ARAZZO

UKG Cross-System Employee Reconcile

Match an HCM employee record against the WFM roster for the same person.

ARAZZO

UKG Pro WFM Daily Attendance Reconcile

Compare a day's scheduled shifts to actual punches for an employee.

ARAZZO

UKG Pro HCM Employee 360 Profile

Resolve an employee from the directory and assemble their core HCM profile.

ARAZZO

UKG Pro HCM Employee Roster Bootstrap

Page the employee ID list, then hydrate one employee into a full record.

ARAZZO

UKG Pro HCM New Hire Org Placement

Validate org references then submit a department transfer for an employee.

ARAZZO

UKG Pro HCM Payroll Statement Review

Assemble an employee's pay rate, statement history, and deposit accounts.

ARAZZO

UKG Pro WFM PTO Balance and Schedule Check

Read an employee's accrual balances and branch on available PTO.

ARAZZO

UKG Pro WFM Schedule Coverage Check

Pull a location schedule, drill into one employee, and check their accruals.

ARAZZO

UKG Pro HCM Submit Personnel Change

Validate an employee, submit a personnel action, and branch on its status.

ARAZZO

UKG Pro WFM Timecard Period Review

Resolve an employee, pull their timecards, and branch on approval status.

ARAZZO

Pricing Plans

Ukg Plans Pricing

1 plans

PLANS

Rate Limits

Ukg Rate Limits

1 limits

RATE LIMITS

FinOps

Ukg Finops

FINOPS

Features

Human Capital Management

Comprehensive HCM covering employee records, org management, talent, and compliance for enterprise organizations.

Payroll Processing

Full-service payroll with tax compliance, direct deposit, pay statements, and multi-state support.

Benefits Administration

Benefits enrollment, plan management, life event processing, and ACA compliance tracking.

Time and Attendance

Automated timekeeping with punch clocks, mobile entry, approval workflows, and FLSA compliance.

Workforce Scheduling

AI-powered scheduling with demand forecasting, shift management, and coverage optimization.

Accrual Management

Configurable vacation, sick, and PTO accrual policies with automated balance tracking.

HR Service Delivery

Employee case management, knowledge portal, HR document management, and process automation.

People Fabric

Unified data platform connecting HCM and WFM data across all UKG products via modern APIs.

Use Cases

Payroll Integration

Sync employee pay data, deductions, and tax information with third-party payroll processors and ERP systems.

Benefits Connector

Exchange enrollment data and eligibility with benefits carriers, insurance providers, and benefits administration systems.

Time and Labor Integration

Import punch data, approved timecards, and schedule information into payroll and workforce analytics platforms.

HRIS Data Sync

Keep employee demographic, job, and organizational data synchronized between UKG and downstream business systems.

Analytics and Reporting

Export workforce data to business intelligence tools and data warehouses for advanced analytics and reporting.

Onboarding Automation

Automate new hire provisioning by triggering downstream system access and equipment setup from UKG hire events.

Integrations

Salesforce

Sync employee data between UKG and Salesforce for HR-CRM alignment.

SAP

Integrate with SAP ERP for GL posting, cost center management, and financial reconciliation.

Microsoft Azure AD

Single sign-on and user provisioning integration with Microsoft Entra ID.

Workday

Employee data exchange for organizations using both platforms during migration or hybrid scenarios.

ADP

Payroll data exchange with ADP for organizations using both HCM and payroll platforms.

Greenhouse

Applicant tracking system integration for recruiting and onboarding handoff.

Solutions

UKG Pro

Enterprise HCM platform for mid-market and enterprise organizations with full HR, payroll, and talent capabilities.

UKG Pro WFM

Workforce management platform for hourly and complex workforce scheduling, timekeeping, and compliance.

UKG Ready

Simplified HCM solution for small and medium businesses with combined HR, payroll, and time management.

UKG HR Service Delivery

Employee experience platform for HR case management, knowledge delivery, and document compliance.

Semantic Vocabularies

Ukg Pro Hcm Context

13 classes · 62 properties

JSON-LD

Ukg Pro Wfm Context

6 classes · 28 properties

JSON-LD

API Governance Rules

UKG API Rules

30 rules · 14 errors 12 warnings 4 info

SPECTRAL

JSON Structure

Pro Hcm Benefits Election Structure

8 properties

JSON STRUCTURE

Pro Hcm Department Structure

5 properties

JSON STRUCTURE

Pro Hcm Direct Deposit Structure

6 properties

JSON STRUCTURE

Pro Hcm Employee Id List Structure

3 properties

JSON STRUCTURE

Pro Hcm Employee Job Structure

8 properties

JSON STRUCTURE

Pro Hcm Employee List Structure

3 properties

JSON STRUCTURE

Pro Hcm Employee Structure

10 properties

JSON STRUCTURE

Pro Hcm Location Structure

7 properties

JSON STRUCTURE

Pro Hcm Pay Rate Structure

6 properties

JSON STRUCTURE

Pro Hcm Pay Statement Structure

12 properties

JSON STRUCTURE

Pro Hcm Personnel Change Request Structure

7 properties

JSON STRUCTURE

Pro Hcm Personnel Change Response Structure

3 properties

JSON STRUCTURE

Pro Wfm Accrual Balance Structure

6 properties

JSON STRUCTURE

Pro Wfm Punch Request Structure

4 properties

JSON STRUCTURE

Pro Wfm Punch Structure

6 properties

JSON STRUCTURE

Pro Wfm Shift Structure

9 properties

JSON STRUCTURE

Pro Wfm Timecard Structure

8 properties

JSON STRUCTURE

Pro Wfm Wfm Employee Structure

8 properties

JSON STRUCTURE

Example Payloads

Pro Hcm Benefits Election Example

8 fields

EXAMPLE

Pro Hcm Department Example

5 fields

EXAMPLE

Pro Hcm Direct Deposit Example

6 fields

EXAMPLE

Pro Hcm Employee Example

10 fields

EXAMPLE

Pro Hcm Employee Id List Example

3 fields

EXAMPLE

Pro Hcm Employee Job Example

8 fields

EXAMPLE

Pro Hcm Employee List Example

3 fields

EXAMPLE

Pro Hcm Location Example

7 fields

EXAMPLE

Pro Hcm Pay Rate Example

6 fields

EXAMPLE

Pro Hcm Pay Statement Example

12 fields

EXAMPLE

Pro Hcm Personnel Change Request Example

7 fields

EXAMPLE

Pro Hcm Personnel Change Response Example

3 fields

EXAMPLE

Pro Wfm Accrual Balance Example

6 fields

EXAMPLE

Pro Wfm Punch Example

6 fields

EXAMPLE

Pro Wfm Punch Request Example

4 fields

EXAMPLE

Pro Wfm Shift Example

9 fields

EXAMPLE

Pro Wfm Timecard Example

8 fields

EXAMPLE

Pro Wfm Wfm Employee Example

8 fields

EXAMPLE

Resources

PostmanWorkspace

PostmanWorkspace

GitHubOrganization

GitHubOrganization

Documentation

TermsOfService

PrivacyPolicy

GettingStarted

Authentication

SpectralRules

Sources

opencollection: 1.0.0
info:
  name: UKG Pro Workforce Management API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Employees
    type: folder
  items:
  - info:
      name: UKG Pro WFM List Employees
      type: http
    http:
      method: GET
      url: https://api.ultipro.com/workforce/v1/v1/employees
      params:
      - name: limit
        value: '50'
        type: query
        description: Maximum number of records to return
      - name: offset
        value: '0'
        type: query
        description: Number of records to skip
      - name: locationId
        value: LOC-NYC
        type: query
        description: Filter by work location
    docs: Retrieve employee records from the WFM system including workforce attributes.
- info:
    name: Timekeeping
    type: folder
  items:
  - info:
      name: UKG Pro WFM Get Employee Timecards
      type: http
    http:
      method: GET
      url: https://api.ultipro.com/workforce/v1/v1/employees/:employeeId/timecards
      params:
      - name: employeeId
        value: EMP001
        type: path
        description: Employee identifier
      - name: startDate
        value: '2026-01-01'
        type: query
        description: Start date for timecard retrieval
      - name: endDate
        value: '2026-01-14'
        type: query
        description: End date for timecard retrieval
    docs: Retrieve timecard records for an employee within a date range.
  - info:
      name: UKG Pro WFM Get Employee Punches
      type: http
    http:
      method: GET
      url: https://api.ultipro.com/workforce/v1/v1/employees/:employeeId/punches
      params:
      - name: employeeId
        value: EMP001
        type: path
        description: Employee identifier
      - name: startDate
        value: '2026-01-01'
        type: query
        description: Start date for punch retrieval
      - name: endDate
        value: '2026-01-14'
        type: query
        description: End date for punch retrieval
    docs: Retrieve clock punch records for an employee.
  - info:
      name: UKG Pro WFM Create Punch
      type: http
    http:
      method: POST
      url: https://api.ultipro.com/workforce/v1/v1/employees/:employeeId/punches
      params:
      - name: employeeId
        value: EMP001
        type: path
        description: Employee identifier
      body:
        type: json
        data: '{}'
    docs: Submit a clock punch for an employee (in, out, or transfer).
- info:
    name: Accruals
    type: folder
  items:
  - info:
      name: UKG Pro WFM Get Employee Accruals
      type: http
    http:
      method: GET
      url: https://api.ultipro.com/workforce/v1/v1/employees/:employeeId/accruals
      params:
      - name: employeeId
        value: EMP001
        type: path
        description: Employee identifier
    docs: Retrieve accrual balances for an employee including vacation, sick, and PTO.
- info:
    name: Scheduling
    type: folder
  items:
  - info:
      name: UKG Pro WFM List Schedules
      type: http
    http:
      method: GET
      url: https://api.ultipro.com/workforce/v1/v1/schedules
      params:
      - name: locationId
        value: LOC-NYC
        type: query
        description: Location to retrieve schedules for
      - name: startDate
        value: '2026-01-01'
        type: query
        description: Start date for schedule retrieval
      - name: endDate
        value: '2026-01-07'
        type: query
        description: End date for schedule retrieval
    docs: Retrieve employee schedules for a location and date range.
  - info:
      name: UKG Pro WFM Get Employee Shifts
      type: http
    http:
      method: GET
      url: https://api.ultipro.com/workforce/v1/v1/employees/:employeeId/shifts
      params:
      - name: employeeId
        value: EMP001
        type: path
        description: Employee identifier
      - name: startDate
        value: '2026-01-01'
        type: query
        description: Start date
      - name: endDate
        value: '2026-01-14'
        type: query
        description: End date
    docs: Retrieve scheduled shifts for a specific employee.
bundled: true