Skip to main content
Retrieve employees employment details. Required permission: View role for the Personnel Integration web service.
External DocumentationTo learn more, visit the UKG Pro HCM documentation.

​
Basic Parameters

ParameterDescription
Company IDA comma-separated list of company IDs to filter the results by.
Employee IDThe ID of the employee to get employment details for.
Job TitleThe job title of the employee to filter the results by.
PageThe page number to get the results from.
Per PageThe maximum number of results to return per page.
Primary Job CodeA comma-separated list of primary job codes to filter the results by.
Primary Project CodeA comma-separated list of primary project codes to filter the results by.
Primary Work Location CodeA comma-separated list of primary work location codes to filter the results by.
Return All PagesAutomatically fetch all resources, page by page.

​
Advanced Parameters

ParameterDescription
Date Last Pay Date PaidThe date of an employee’s most recently paid pay date to filter the results by.
Date Of RetirementThe date of retirement of the employee to filter the results by.
Date Of TerminationThe date of termination of the employee to filter the results by.
Date Time ChangedThe date of change in the employee’s details to filter the results by.
Date Time CreatedThe date of creation of the employee to filter the results by.
Deduction Group CodeA comma-separated list of deduction group codes to filter the results by.
Earning Group CodeA comma-separated list earning group codes to filter the results by.
Employee NumberThe identifier of the employee to filter the results by.
Employee Status CodeA comma-separated list employee status codes to filter the results by.
Employee Type CodeA comma-separated list employee type codes to filter the results by.
Full Time Or Part Time CodeA code indicating whether the employee is full-time or part-time.
Is Home CompanySelect whether the current company is the employee’s home company.
Last Hire DateThe most recent hire date (if rehired) to filter the results by.
Original Hire DateThe date when the employee was hired to filter the results by.
Pay GroupA comma-separated list pay group codes to filter the results by.
Supervisor IDThe ID of the supervisor of the employee to filter the results by.

​
Example Output

[
	{
		"companyID": "string",
		"employeeID": "string",
		"homeCompany": "string",
		"primaryJobCode": "string",
		"jobCode": "string",
		"jobGroupCode": "string",
		"annualSalary": 0,
		"mailstop": "string",
		"okToRehire": "string",
		"plannedLeaveReason": "string",
		"positionCode": "string",
		"salaryOrHourly": "string",
		"scheduledAnnualHours": 0,
		"scheduledFTE": 0,
		"scheduledWorkHours": 0,
		"shift": "string",
		"shiftGroup": "string",
		"terminationReasonCode": "string",
		"terminationDescription": "string",
		"termType": "string",
		"timeClockID": "string",
		"weeklyHours": 0,
		"orgLevel1Code": "string",
		"orgLevel2Code": "string",
		"orgLevel3Code": "string",
		"orgLevel4Code": "string",
		"jobTitle": "string",
		"fullTimeOrPartTimeCode": "string",
		"primaryWorkLocationCode": "string",
		"languageCode": "string",
		"jobChangeReasonCode": "string",
		"primaryProjectCode": "string",
		"workPhoneNumber": "string",
		"workPhoneExtension": "string",
		"workPhoneCountry": "string",
		"deductionGroupCode": "string",
		"earningGroupCode": "string",
		"employeeTypeCode": "string",
		"employeeStatusCode": "string",
		"employeeNumber": "string",
		"leaveReasonCode": "string",
		"autoAllocate": "string",
		"clockCode": "string",
		"supervisorID": "string",
		"originalHireDate": "string",
		"dateInJob": "string",
		"dateLastWorked": "string",
		"benefitSeniorityDate": "string",
		"seniorityDate": "string",
		"lastHireDate": "string",
		"dateTimeCreated": "string",
		"dateTimeChanged": "string",
		"dateLastPayDatePaid": "string",
		"employeeStatusExpectedEndDate": "string",
		"integrationRecordId": "string",
		"currentCompanyCountryCode": "string",
		"homeCompanyCountryCode": "string",
		"hourlyPayRate": 0,
		"salaryEffectiveDate": "string",
		"unionLocalCode": "string",
		"unionNationalCode": "string",
		"earlyRetirementDate": "string",
		"retirementDate": "string",
		"suspensionDate": "string",
		"terminationDate": "string",
		"payGroupCode": "string",
		"payPeriod": "string",
		"paidThruDate": "string",
		"employeeStatusStartDate": "string",
		"hireSource": "string",
		"isHomeCompany": true,
		"isSupervisor": true,
		"isAutoAllocated": true,
		"isAutoPaid": true,
		"isHighlyCompensated": true,
		"isMultipleJob": true,
		"isKeyEmployee": true,
		"page": 0,
		"per_Page": 0
	}
]

​
Workflow Library Example

List Employees Employment Details with Ukg Pro Hcm and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop