Turn your existing data & APIs into governed capabilities for AI →

API Learnings

Toolbox

API Evangelist LLC

ukg

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 structure. Uses Basic Authentication with service account credentials and tenant-specific API keys. Enables integrations with HR systems, payroll processors, benefits administrators, and workforce analytics platforms.

Documentation GitHub OpenAPI

Documentation

https://developer.ukg.com/hcm/reference/welcome-to-the-ukg-pro-api

Specifications

openapi/ukg-pro-hcm-openapi.yml

Schemas & Data

json-schema/pro-hcm-employee-schema.json

json-schema/pro-hcm-employee-job-schema.json

json-schema/pro-hcm-pay-rate-schema.json

json-schema/pro-hcm-benefits-election-schema.json

json-schema/pro-hcm-department-schema.json

json-schema/pro-hcm-location-schema.json

json-schema/pro-hcm-pay-statement-schema.json

json-schema/pro-hcm-direct-deposit-schema.json

json-schema/pro-hcm-personnel-change-request-schema.json

json-schema/pro-hcm-personnel-change-response-schema.json

json-schema/pro-hcm-employee-list-schema.json

json-schema/pro-hcm-employee-id-list-schema.json

json-structure/pro-hcm-employee-structure.json

json-structure/pro-hcm-employee-job-structure.json

json-structure/pro-hcm-pay-rate-structure.json

json-structure/pro-hcm-benefits-election-structure.json

json-structure/pro-hcm-department-structure.json

json-structure/pro-hcm-location-structure.json

json-structure/pro-hcm-pay-statement-structure.json

json-structure/pro-hcm-direct-deposit-structure.json

json-structure/pro-hcm-personnel-change-request-structure.json

json-structure/pro-hcm-personnel-change-response-structure.json

json-structure/pro-hcm-employee-list-structure.json

json-structure/pro-hcm-employee-id-list-structure.json

Examples

examples/pro-hcm-employee-example.json

examples/pro-hcm-employee-job-example.json

examples/pro-hcm-pay-rate-example.json

examples/pro-hcm-benefits-election-example.json

examples/pro-hcm-department-example.json

examples/pro-hcm-location-example.json

examples/pro-hcm-pay-statement-example.json

examples/pro-hcm-direct-deposit-example.json

examples/pro-hcm-personnel-change-request-example.json

examples/pro-hcm-personnel-change-response-example.json

examples/pro-hcm-employee-list-example.json

examples/pro-hcm-employee-id-list-example.json

Other Resources

json-ld/ukg-pro-hcm-context.jsonld

OpenAPI

#HCM #Employees #Payroll #Benefits #Personnel Actions

← Back to U APIs