Skip to main content

UKG Pro API Endpoints

Updated this week

The UKG Pro base URL is unique to each environment and can vary in format. There is no single universal URL. It depends on the specific environment, for example, service5.

Portal/Instance Identifier: https://{Instance Identifier}.ultipro.com

Base URLs:

  • Staging: https://{Instance Identifier}.ultipro.com

  • Production: https://{Instance Identifier}.ultipro.com

NOTE: The {Instance Identifier} shown above is just a placeholder . Replace it with your actual UKG Pro API URL. Since you might have multiple test environments, this identifier will be different for each one.

Table of Contents

Compensation Detail Endpoint

Get a Compensation Detail: (GET)

[BaseURL]/personnel/v1/compensation-details/{id}

Employee Employment Endpoint

Get all Employees: (GET)

[BaseURL]Employee Employment Details_GET()

Get an Employee: (GET)

[BaseURL] companyID={companyId}&employeeID={employeeId}

Person Details Endpoint

Get all Person Details: (GET)

[BaseURL] employeeId={_id}

Get a Person’s Details: (GET)

[BaseURL] /personnel/v1/person-details/{id}

Platform Configuration Endpoint

Get Configuration Fields: (GET)

[BaseURL] /personnel/v2/platform-configuration-fields/class-name/{className}

Did this answer your question?