View role for the Personnel Integration web service.
External DocumentationTo learn more, visit the UKG Pro HCM documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Company ID | A comma-separated list of company IDs to filter the results by. |
| Employee ID | The ID of the employee to get employment details for. |
| Job Title | The job title of the employee to filter the results by. |
| Page | The page number to get the results from. The value must be greater than 0. |
| Per Page | The maximum number of results to return per page. |
| Primary Job Code | A comma-separated list of primary job codes to filter the results by. |
| Primary Project Code | A comma-separated list of primary project codes to filter the results by. |
| Primary Work Location Code | A comma-separated list of primary work location codes to filter the results by. |
| Return All Pages | Automatically fetch all resources, page by page. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Date Last Pay Date Paid | The date of an employee’s most recently paid pay date to filter the results by. |
| Date Of Retirement | The date of retirement of the employee to filter the results by. |
| Date Of Termination | The date of termination of the employee to filter the results by. |
| Date Time Changed | The date of change in the employee’s details to filter the results by. |
| Date Time Created | The date of creation of the employee to filter the results by. |
| Deduction Group Code | A comma-separated list of deduction group codes to filter the results by. |
| Earning Group Code | A comma-separated list earning group codes to filter the results by. |
| Employee Number | The identifier of the employee to filter the results by. |
| Employee Status Code | A comma-separated list employee status codes to filter the results by. |
| Employee Type Code | A comma-separated list employee type codes to filter the results by. |
| Full Time Or Part Time Code | A code indicating whether the employee is full-time or part-time. |
| Is Home Company | Select whether the current company is the employee’s home company. |
| Last Hire Date | The most recent hire date (if rehired) to filter the results by. |
| Original Hire Date | The date when the employee was hired to filter the results by. |
| Pay Group | A comma-separated list pay group codes to filter the results by. |
| Supervisor ID | The 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
}
]