/ta/rest/v2/companies/{cid}/employees. This {cid} is UKG Ready’s own internal company short code — it isn’t returned anywhere in Finch’s standard API today, and UKG Ready’s REST API also requires it to be URL-encoded with a leading pipe character (%7C{cid}).
To save you from having to look this identifier up and hand-encode it yourself, use the literal placeholder {{company_id}} anywhere your route needs that segment. Finch will substitute it with your connection’s correctly-encoded company code before forwarding the request.
Example request — listing an Employer’s cost centers:
{{company_id}} placeholder can appear anywhere in the route (including more than once) and is only substituted when present — a route you’ve already hardcoded with your own %7C{cid} value continues to work unchanged.
For the full set of available v2 endpoints, see the UKG Ready API documentation.
A UKG Ready request returning
403 { "code": 42, "message": "Security violation." } is not a Finch or forwarding issue — it means the UKG Ready user associated with your connection doesn’t have the required permission for that specific endpoint (for example, cost center endpoints require the View: Cost Center Definitions and View: Cost Centers permissions on that user’s UKG Ready security profile). Your UKG Ready administrator will need to grant the relevant permission; no reconnection is required afterward, since UKG Ready evaluates permissions per request.