Available UKG Pro APIs

Naga Sri Hari Gonaboyina

Updated January 24, 2025 19:47

When you configure an export, import, or other type of flow step using the prebuilt UKG Pro connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the UKG Pro API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Audit details	Get audit details data	X
Background check order details	Get background check details	X
Candidate request	Background check request		X
Candidate request	Background check status		X
Company details	Get company details	X
Compensation details	Get all compensation details	X
	Get all compensation details by company	X
	Get all compensation details by company and employee	X
	Get all compensation details by employee	X
Contacts	Get all details for a person assigned to an employee as a contact	X
Contacts	Get all details for a single person assigned to an employee as a contact	X
Direct deposit	Get list of direct deposit details for US and Canadian employees	X
Direct deposit	Get list of direct deposit details for US and Canadian employees by company	X
Earnings	Get a list of all earnings configurations	X
	Get list of earnings configurations filtered by Parameter including pagination params	X
	Get a specific earning configuration	X
Empdeductions	Get employee deductions	X
Empdeductions	Get employee deductions	X
Employee change	Changes by date	X
Employee change	Changes by employee ID	X
Employee contract details	Get all employment contract details	X
Employee cobra details	Get employee cobra details	X
Employee deductions benefit option change date	Get employee deduction benefit option change date	X
Employee deductions history effective change date	Deduction history effective change date	X
Employee demographic details	Get employee demographic details	X
Employee global bank	Get all direct deposit details for global employees	X
Employee global localization elements	Get all global employee localization fields added to UKG Pro	X
Employee lookup	Employee ID lookup		X
Employee multiple jobs details	Get employee multiple jobs details	X
Employee pay deductions element	Get global employee payments and deductions service	X
Employee pay statement	Get employee pay statement based on the given pay identifier	X
Employees profile	Get list of employees profile	X
Employment details	Get Employment Details	X
	Get all employment record details by company	X
	Get a single employment detail by company	X
Employment supervisor details	Get employee supervisor details	X
Employee education	Get all education details	X
Employee employment details	Get employee employment details	X
Employee extended elements	Get employee extended elements	X
Employee job history details	Get all employee job history details	X
Employee job history details	Get a single job history detail record	X
Employee multiple phone numbers	Get employee multiple phone numbers	X
Employee multiple positions	Get employee multiple positions	X
Employee national document details	Get employee national document details	X
General ledger	Returns a list of details for a general ledger run	X
General ledger	Returns a list of details for a general ledger run	X
Import tool	Takes an XML transaction and feeds it into the import tool		X
Insurance rate	Get insurance Rate	X
Insurance rate	Retrieves the status of an import tool transaction	X
Integration audit configuration	Get integration audit configuration data	X
International employee	Get international employee details for all employees	X
International employee	Get a single employees international details	X
Job group	Retrieve all job groups	X
Jobs	Retrieve all jobs configurations	X
Jobs	Retrieve a single job configurations	X
Locations	Retrieve all locations configurations	X
Locations	Retrieve a single location configurations	X
New hires	Gets a single new hire by id	X
New hires	Creates a single new hire		X
On demand pay hours worked	Add hours worked entries		X
Open enrollment dependent deductions	Get open enrollment dependent deductions data	X
Open enrollment Employee deductions	Get open enrollment employee deductions	X
Option rate	Get option rate data	X
Organization levels	Get all org-levels	X
	Get single org-levels	X
	Creates org-level configuration		X
	Patch one org-level		X
	Update one org-level		X
Pay register	Get Pay Register	X
Paygroup payperiods	Get PayGroup PayPeriods	X
Payroll deductions history	Get payroll deductions history	X
Payroll earnings import	Get status details for specified earning	X
Payroll earnings import	Add UKG Pro time clock data		X
Person details	Get all person details	X
	Get all person details for a single company	X
	Get all person detail record for a single company	X
	Get a single company detail record	X
Position reports	Get position report	X
Positions	Returns list of employee position information filtered on various parameters	X
Postings	Get job postings	X
PTO plans	Get all PTO plans	X
	Get a specific PTO plan	X
	Get a specific employee PTO plan	X
	Create a PTO plan		X
	Patch a PTO plan		X
Shiftcodes	Shift codes api data	X
Tax groups	Get all tax group details	X
Time and attendance schedule import	Obtains all activities	X
	Obtains all assigned holidays	X
	Obtains all jobs for an employee	X
	Obtains all employees	X
	Obtains all hour types	X
	Obtains all teams	X
	Obtains all time codes	X
	Obtains all time off requests	X
	Obtains a UTA employee by COID and EEID	X
	Publish schedule details		X
User defined fields	Get user defined fields	X
	Get user defined fields for single company	X
	Get user defined fields for a single employee in a single company	X
User details	Get user details	X
User preferences	Get user preferences details	X
User profile details	Get all user profile details	X