UKG HR Service Delivery API Lifecycle and Deprecation Policy

Overview

UKG HR Service Delivery REST APIs evolve to offer new capabilities while ensuring stability for customers. This document explains the lifecycle policy and deprecation rules for UKG HR Service Delivery APIs, helping developers plan upgrades effectively and avoid disruptions.

API lifecycle

Each API version follows a managed lifecycle that includes release, maintenance, and eventual deprecation.

Stage	Description
Active	Fully supported and maintained. Receives new features and bug fixes.
Maintenance	Still supported but only receives critical security updates and bug fixes. No new features are added.
Deprecated	Officially announced for retirement. Customers should migrate to newer versions as soon as possible.
Retired	Fully removed from service. API endpoints no longer accessible.

Deprecation process

When an API or feature is deprecated, UKG communicates the change well in advance. The process includes:

Announcement — A formal communication via release notes and documentation updates.
Transition period — Time window (usually 6–12 months) for customers to migrate to the new version.
Removal — Deprecated API endpoints become inaccessible after the announced retirement date.

Customers are encouraged to subscribe to the UKG HR Service Delivery documentation or release notes to stay informed.

Current status

API version	Status	Deprecation date	Retirement date
v2	Active	—	—
v1	Deprecated	April 2024	October 1, 2025

Important:
All users of API v1 must migrate to API v2 before October 1, 2025, as v1 endpoints will no longer be available after this date.

Migration recommendations

Review the API v2 documentation.
Update integrations to use the new endpoints (/api/v2/).
Ensure authentication is performed using OAuth 2.0 tokens.
Validate field mappings, as API v2 uses improved data models.
Test integrations in a staging environment before switching to production.

Communication policy

UKG communicates deprecation notices via:

Release notes and documentation updates.
Direct email notifications to technical contacts.
Public developer portal announcements.

Customers should maintain up‑to‑date contact information to ensure they receive all notifications.

Support commitment

During the deprecation period, UKG guarantees:

Continued operation of existing endpoints until retirement date.
Assistance from the support team for migration questions.
Security and compliance updates.

Once an API is retired, access is permanently removed. No additional support will be provided for legacy endpoints.

Summary

API v1 → deprecated, retired October 1, 2025.
API v2 → active and fully supported.