How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UKG Employees API

Employee records and demographic data

UKG Employees API is one of 9 APIs that UKG publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 36 JSON Schema definitions.

Tagged areas include Employees. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 36 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against 2 base URLs: https://service.ultipro.com, https://service.ultipro.ca.

5 operations 5 paths 5 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://service.ultipro.com
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

UKG Employees API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Basic authentication with service account credentials plus US-API-Key header

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Employees 5

Employee records and demographic data

GET
/personnel/v2/employee-ids
UKG Pro HCM List Employee IDs
listEmployeeIds 2 params → 200401403
GET
/personnel/v2/employees
UKG Pro HCM List Employees
listEmployees 3 params → 200401403
GET
/personnel/v2/employees/{employeeId}
UKG Pro HCM Get Employee
getEmployee 1 param → 200404401
GET
/personnel/v2/employees/{employeeId}/jobs
UKG Pro HCM Get Employee Jobs
getEmployeeJobs 1 param → 200404401
GET
/v1/employees
UKG Pro WFM List Employees
listWfmEmployees 3 params → 200401403

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Employee (10 properties), EmployeeJob (8 properties), WfmEmployee (8 properties), EmployeeList (3 properties). Each schema is shown below with its type and property counts.

WfmEmployee
object
Employee record in WFM system
8 properties
EmployeeIdList
object
Paginated list of employee identifiers
3 properties
EmployeeList
object
Paginated list of employee records
3 properties
EmployeeJob
object
Employee job assignment and classification details
8 properties
Employee
object
Employee record with demographic and employment information
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ukg-employees-api-openapi.yml Raw ↑

Other APIs UKG publishes across the network.

UKG HR Service Delivery API
UKG Accruals API
UKG Benefits API
UKG Organization API
UKG Payroll API
UKG Personnel Actions API
UKG Scheduling API
UKG Timekeeping API
Where this information came from

This is an independent, third-party profile of UKG Employees API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.