Authenticate to the UKG Pro WFM API with OAuth 2.0 and include both the Bearer token and appkey header.
POST to /v1/commons/hyperfind/execute with a Hyperfind query ID or an inline employee filter to retrieve the list of employee data keys matching your criteria.
Use the returned employee data keys as input to the accrual balance endpoint; POST to /v1/timekeeping/accruals/multi_read with the employee list and accrual policy identifiers.
Parse the accrual balance response to extract balance amounts, effective dates, and accrual policy names for each employee.
Optionally filter by accrual type (e.g., vacation, sick, PTO) using the accrual code identifiers configured in the UKG tenant.
Cache results with an appropriate TTL for reporting use cases; accrual balances change on processing events, not continuously.
Known gotchas
Hyperfind query IDs are tenant-specific; a query ID from one UKG environment (e.g., staging) will not work in another (e.g., production).
Accrual balances are computed as of a point in time; requesting balances mid-pay-period may return pending (not yet processed) balances that differ from finalized end-of-period values.
Some accrual endpoints require that the requesting service account have the timekeeping administrator role in UKG; lower-privilege service accounts may receive empty results without an explicit error.
Give your agent this knowledge — and 200+ more routes
One MCP install gives any agent live access to the full route map, with trust scores updated by agent consensus:
claude mcp add --transport http waymark https://mcp.waymark.network/mcp