Available UKG Ready APIs

Tanisha Ray

Updated November 26, 2024 16:31

When you configure an export, import, or other type of flow step using the prebuilt UKG Ready 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 UGK Ready API documentation. You can also create a composite endpoint for this application in HTTP mode.

API version: V1

Resource	Endpoint	Export	Import
Company: Employee type	Create employee type	X
Company: Employee type	Update employee type		X
Company: Holiday profiles	Create holiday profile		X
Company: Holiday profiles	Update holiday profile		X
Company: Pay period profiles	Get pay period profiles	X
	Create pay period profiles		X
	Update pay period profiles		X
	Delete pay period profiles		X
Company: Pay types	Get pay types	X
	Create pay types		X
	Update pay types		X
	Delete pay types		X
Company: Profiles	Get profiles	X
Company: Rate items	Fetch rate table items	X
	Create rate items		X
	Update rate items		X
	Delete rate items		X
Company: Rate tables	Get rate tables	X
	Create rate tables		X
	Update rate tables		X
	Delete rate tables		X
Company: Skills	Create skill		X
	Update skill		X
	Delete skill		X
Company: Time offs	Get time off categories	X
	Create time off categories		X
	Update time off categories		X
	Delete time off categories		X
Data exports	Get all data exports	X
Data export status	Get current export status	X
Employees	Endpoint for fetching employees	X
	Create employees		X
	Put employees		X
Employees status	Change account status API		X
Employee: Accrual balances	Get employee's accrual balances	X
	Update employee accrual balances		X
	Update employee accrual balances		X
Employee all PTO requests	All PTO requests	X
Employee: Contracts	Create employee contracts		X
	Update existing employee contracts		X
	Delete employee's contracts		X
Employee: PTO request	Get list of time off requests for self	X
	Create time off request		X
	Delete time off requests		X
Employee: PTO request notes	PTO request notes	X
Employee: Time entry notes	Get time entry notes	X
	Create time entry notes		X
	Delete time entry notes		X
Employee: To do	Fetch workflow to do items	X
Employee: To do action	To do action		X
Employee: To do count	To do count	X
Employee work time preferences	Get employee work time preferences	X
	Create employee work time preferences		X
	Update existing employee work time preferences		X
	Delete employee work time preferences		X
Imports	Get list of Imports	X
Import status	Get current status of import	X
Reports	Get list of available reports	X
Report global	Get global report by ID	X
Report global	API report global		X
Report global metadata	Retrieve report metadata	X
Saved report	Get saved report	X
Saved report	API		X
Saved report metadata	Retrieve report metadata	X
Web clock	Post web clock		X

API version: V2

Resource	Endpoint	Export	Import
Company: Access policy profile	Get policy profile		X
	Update an existing access policy profile		X
	Delete an existing access policy profile		X
Company: Access policy profiles	Create access policy profiles	X
Company: Accrual balances update	Create accrual balances update		X
Company: Accrual balances update	Update accrual balances update		X
Company: All data export	All data export
Company: Applicant	Get applicant account	X
	Update applicant account	X	X
	Delete applicant account		X
Company: Applicants	Get list of applicants
Company: Applicants	Create a new applicant	X	X
Company: Applicant job applications	Get list of all job applications
Company: Asset assignment	Fetch asset assignment	X
	Replace the asset assignment		X
	Delete asset assignment		X
Company:Asset assignments	Get a list of all asset assignments
Company:Asset assignments	create a new asset assignment	X	X
Company: Asset assignment action	Update asset assignment action		X
Company: Background job processing status	Retrieving a job processing status	X
Company: Background screening order status	Receive background screening order status		X
Company: Benefit plans	Fetch list of benefit plans for employees	X
Company: Benefit plan	Fetch employee benefit plan	X
Company: Calendar anniversary calendar	Anniversary calendar	X
Company: Calendar birthday calendar	Birthday calendar	X
Company: Compensation additional compensation	Additional compensation	X
Company: Compensation additional compensation data	Get additional compensation data	X
	Update additional compensation data		X
	Delete additional compensation data		X
Company: Compensation history	Get compensation history	X
Company: Compensation history	Create compensation history		X
Company: Compensation history data	Get compensation history data	X
	Update compensation history data		X
	Delete compensation history data		X
Company: Compensation history notes	Return a list of notes for specified base compensation	X
Company: Compensation total compensation	Return total compensation information for all subordinates	X
Company: Configuration account group	Retrieve account group	X
	Update account group		X
	Delete account group		X
Company: Configuration account groups	Get list of account groups	X
Company: Configuration account groups	Create account group		X
Company: Configuration account group manager	Retrieve regular account group manager
	Replace account group manager	X	X
	Delete account group manager		X
Company: Configuration account group managers	Get account group menagers	X
Company: Configuration account group managers	Create account group manager		X
Company: Configuration account group member	Get account group member	X
Company: Configuration account group member	Delete account group member		X
Company: Configuration account group members	Get account group members	X
Company: Configuration account group members	Create account group member		X
Company: Configuration announcement	Get announcement	X
	Update announcement		X
	Delete announcement		X
Company: Configuration announcements	Get announcements	X
Company: Configuration announcements	Create announcements		X
Company: Contact	Employee contact API	X
	Update existing employee's contacts		X
	Delete employee contact		X
Company: Contacts	Create employee contacts		X
Company: Contracts	Create employee contracts		X
	Update existing employee's contracts		X
	Delete contracts		X
Company: Cost center	Retrieve cost center information	X
Company: Cost center	Update cost center		X
Company: Cost centers	Get cost centers
Company: Cost center actions	Cost center action	X	X
Company: Cost center job	Get cost center job
	Update cost center job		X
	Delete cost center job	X	X
Company: Cost center jobs	Get cost center jobs
Company: Cost center jobs	Create cost center job	X	X
Company: Cost center list	Get cost center list
	Update cost center list		X
	Delete cost center list	X	X
Company: Cost center lists	Get cost center lists
Company: Cost center lists	Create cost center	X	X
Company: Counter adjustments notes	Get counter adjustments notes	X
	Create counter adjustments note		X
	Delete counter adjustments note		X
Company: Data delivery data view	Data view		X
Company: Data delivery metadata	Get company metadata	X
Company: Data export	Get data export	X
Company: Data export execute	Export data	X
Company: Dimensions HCM HCM application details widget	Get HCM application details	X
	Update fields in HCM application details		X
	Enable HCM application details		X
Company: Dimensions HCM HCM system details widget	Get HCM system details	X
	Update fields in dimensions HCM system details		X
	Enable dimensions HCM system details widget		X
Company: Direct deposits	Create a new direct deposit account		X
Company: Direct deposits cancel pre note	Cancel pre note		X
Company: Direct deposits mass edit	Mass edit selected direct deposits		X
Company: Document	Endpoint for receiving a list of uploaded documents	X
Company: Document	Post document		X
Company: Document storage delete multiple	Delete a single or multiple documents	X	X
Company: Document preview	Receive document preview metadata of specified document
Company: Employee	Retriev employee information	X
	Update employee information		X
	Delete employee		X
Company: Employees changed employees	Employee records api	X
Company: Employees my currency	Get current employee currency	X
Company: Employee AccrualBalances	Returns the accrual balance of an employee
Company: Employee additional compensation	Returns list of additional compensation records for specific employee	X
Company: Employee additional compensation	Creates additional compensation record for Employee		X
Company: Employee announcements	Fetch active announcements	X
Company: Employee announcement statistics	Endpoint provides ability to update announcement popup statistics	X	X
Company: Employee attendance	Returns attendance data for a specific employee
Company: Employee badges	Returns the employee badge information	X
Company: Employee badges	Update the employee badge information	X	X
Company: Employee benefit plans	Returns list of employee's benefit plans
Company: Employee contacts	Get employee contacts
Company: Employee counter adjustment notes	Updates a counter adjustment	X	X
Company: Employee counter adjustment notes	Deletes a counter adjustment		X
Company: Employee counter adjustments	Fetch existing counter for specific account in a given date range	X
Company: Employee counter adjustments	Create a counter adjustment for a company's employee account	X	X
Company: Employee credentials	Returns the employee credentials information	X
Company: Employee currency	Get employee currency
Company: Employee deduction	Get employee deduction
	Update employee deduction	X	X
	Delete employee deduction		X
Company: Employee deductions	Get list of employee scheduled deductions	X
Company: Employee deductions	Create new scheduled deduction for the employee		X
Company: Employee demographics	Retrieve the demographic information of an employee	X
Company: Employee demographics	Update employee demographic information		X
Company: Employee direct deposits	Retrieve direct deposit accounts	X
Company: Employee disable announcement popup	Disable popup	X	X
Company: Employee documents	Endpoint for receiving a list of uploaded documents for an employee	X
Company: Employee forms custom	Return available custom forms list	X
Company: Employee forms pay	Return list of employee's pay forms	X
Company: Employee forms system	Return list of employee's system forms	X
Company: Employee history	Return the list of base compensation entries for specific employee	X
Company: Employee holidays	Return holidays from a holiday profile assigned to a single Employee
Company: Employee HR custom fields	Return the employee HR custom fields	X
Company: Employee HR custom fields	Update the employee HR custom fields	X	X
Company: Employee leave of absence cases	Fetch employee's leave of absence cases
Company: Employee leave of absence counters	Endpoint for fetching employee's leave of absence	X
Company: Employee leave of absence counters	Update leave of absence	X	X
Company: Employee leave of absence requests	Get leave of absence requests	X
Company: Employee primary assignment	Return a list of primary assignments for employees
Company: Employee schedules	Fetch schedule items for a single employee
	Update employee schedule	X	X
	Delete employee schedule	X	X
Company: Employee total compensation	Get total compensation for specific employee	X
Company: Managed cost center	Fetch managed cost center	X
Company: Managed cost center	Update managed cost center		X
Company: Managed cost centers	Fetch a list of Managed Cost Centers	X
Company: Managed cost centers	Create managed cost center		X
Company: Notifications mailbox items	Return a list of mailbox items	X
Company: Notifications mailbox items	Create new mailbox item		X
Company: Notifications to do items	Return a list of to-do items for a employee	X