See what the UKG Pro integration can do →

The iPaaS.com integration reads employee data from the UKG Pro Web Services REST API. This page lists every endpoint the integration calls, so subscribers or their MiSP can confirm service-account permissions, whitelist the right host, and check whether a UKG Pro deprecation notice affects the integration.

Areas covered: Company · Person · Employee Employment · Compensation · Platform Configuration

UKG Pro is a multi-tenant platform, and each tenant is served from its own host. There is no single universal URL — the correct host for a tenant is shown in UKG Pro under System Configuration > Security > Web Services.

The same host serves test and production tenants; they differ only by the tenant's own hostname. Enter the full host as the API Url on the iPaaS.com Subscription Settings page.

The UKG Pro Web Services API is a REST API returning JSON. Every request the integration makes is a read (GET); the integration never writes to UKG Pro.

Base URL pattern:

All paths below are appended to that base. Two service namespaces are used: personnel for employee data and configuration for company reference data.

Authentication. Every request carries two credentials together:

There is no separate token or authorization endpoint — UKG Pro does not issue a session token, so both credentials accompany every call. Rotating either credential in UKG Pro requires updating the matching field on the iPaaS.com Subscription Settings page.

Pagination. The list endpoints accept page and per_Page parameters. UKG Pro applies a default page size when neither is supplied. Source: Get all person details (UKG Developer Hub, retrieved 2026-07-29).

Filtering and date operators. List endpoints accept field filters as query parameters. Date-valued filters support four operators — less than (=<), greater than (=>), equal to (=), and between (={minimum,maximum}) — and dates use MM-DD-YYYY format. The integration uses the greater-than operator on dateTimeChanged to retrieve employees changed since its last successful poll. Because the format carries no time component, a poll retrieves everything changed on the relevant day. Source: Get all person details (UKG Developer Hub, retrieved 2026-07-29).

Rate limits. UKG Pro does not publish rate-limit figures for these endpoints. When UKG Pro reports that too many requests have been made, the integration stops the affected transfer and the records are captured on a later run; no subscriber action is required. The request pacing the integration applies is controlled by the throttle settings on the iPaaS.com subscription.

Returns the tenant's company records. The integration calls this when it validates the connection, and keeps the result to resolve a company identifier to its company code when retrieving custom fields.

Returns person records for the tenant. The integration calls this during a scheduled poll, filtered on dateTimeChanged to retrieve only employees changed since the previous run.

Query parameters available on this endpoint include companyId, employeeId, lastName, emailAddress, addressState, addressCountry, dateTimeCreated, dateTimeChanged, nationalId, and nationalIdCountry, plus the page and per_Page pagination parameters.

Returns a single person record. The integration calls this for a Manual Sync, and to retrieve the full record for an employee identified during a poll. The person record also supplies the home address captured by the Employee Address mapping collection.

Returns employment records, which carry the employee's company assignments and identify the home company. The integration calls this filtered by employeeId while assembling an employee, and there is no single-record variant of this endpoint — a single employee's employment is retrieved by filtering this list on companyID and employeeID.

Returns compensation records. The integration calls this filtered by employeeId while assembling an employee; the home-company compensation record supplies the employment status that the Employee mapping collection's filter evaluates.

Returns a single compensation record.

Returns the tenant's configured extension fields for a given record class. The integration calls this with the Person and Employment class names to retrieve an employee's custom field values, using a key built from the employee identifier and the company code.

Note that this is the only endpoint the integration calls in the v2 namespace; all other personnel calls use v1.

UKG Pro Web Services does not expose a separate authorization or token endpoint for this authentication method. Credentials are supplied on every request as described under API Endpoints Intro above.

Service accounts and their permissions are managed in UKG Pro under System Configuration > Security > Service Account Administration. Each service account needs View access to the web services the integration reads — Employee Person Details, Employee Employment Details, Compensation Details, Platform Configuration Fields, and Company Details. Source: Web Service Account (UKG Developer Hub, retrieved 2026-07-29).