Skip to main content
Server path: /ukg-employee-core | Type: Application | PCID required: Yes

Tools

ToolDescription
ukg-employee-core_changes_getChanges By Employee ID
ukg-employee-core_changes_get_allChanges By Date
ukg-employee-core_cobra_details_getGet Employee Cobra Details
ukg-employee-core_contract_getGet all employment contract details
ukg-employee-core_education_getGet all education details
ukg-employee-core_emp_global_localization_element_getGet all global employee localization fields added to UKG Pro
ukg-employee-core_emp_multiple_positions_getGet Employee Multiple Positions
ukg-employee-core_extended_elements_getGet Employee Extended Elements
ukg-employee-core_get_personnel_v1_compensation_detailsGet all compensation details
ukg-employee-core_get_personnel_v1_compensation_details_employee_idGet all compensation details by employee
ukg-employee-core_get_personnel_v1_contactsGet all details for a person assigned to an employee as a contact
ukg-employee-core_get_personnel_v1_contacts_contact_idGet all details for a single person assigned to an employee as a contact
ukg-employee-core_get_personnel_v1_empl_multiple_jobsGet employee multiple jobs details
ukg-employee-core_get_personnel_v1_employee_demographic_detailsGet Employee Demographic Details
ukg-employee-core_get_personnel_v1_employee_job_history_details_system_idGet a single job history detail record
ukg-employee-core_get_personnel_v1_employee_security_user_detailsGet employee security user details
ukg-employee-core_get_personnel_v1_employment_detailsRetrieve Employment Details
ukg-employee-core_get_personnel_v1_international_employees_employee_idGet a single employees international details
ukg-employee-core_get_personnel_v1_person_detailsGet all person details
ukg-employee-core_get_personnel_v1_person_details_employee_idGet a single person detail record
ukg-employee-core_get_personnel_v1_user_profile_detailsGet all user profile details
ukg-employee-core_global_bank_getGet all direct deposit details for global employees
ukg-employee-core_idsEmployee ID Lookup
ukg-employee-core_international_employee_getGet international employee details for all employees
ukg-employee-core_job_history_detail_getGet all employee job history details
ukg-employee-core_multi_phone_numbers_getGet employee multiple phone numbers
ukg-employee-core_national_document_getAll employee national document details
ukg-employee-core_position_report_getGet Position Report
ukg-employee-core_retrieve_employee_employment_detailsRetrieve Employee Employment Details
ukg-employee-core_supervisor_details_getGet Employee Supervisor Details
ukg-employee-core_user_details_get_user_detailsGet User Details

ukg-employee-core_changes_get

Changes By Employee ID Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesEmployee Id

ukg-employee-core_changes_get_all

Changes By Date Parameters:
ParameterTypeRequiredDefaultDescription
startDatestringNoUsed to lookup employee changes within time span
endDatestringNoUsed to lookup employee changes within time span
pagenumberNoPagination, which page you want to see
per_pagenumberNoPagination, how many records per page you want to see

ukg-employee-core_cobra_details_get

Get Employee Cobra Details Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
cobraIsActivebooleanNoCobra Is Active
cobraStatusstringNoCobra Status
dateOfCobraEventstringNoDate Of Cobra Event
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_contract_get

Get all employment contract details Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
contractNumberstringNoContract Number
contractTypeCodestringNoContract Type Code
effectiveDatestringNoUsed to find contracts effective date less than, greater than, equal to, or between passed date(s)
dateTimeCreatedstringNoUsed to find contract record created date less than, greater than, equal to, or between passed date(s)
rowLastChangedstringNoUsed to find contract record changed date less than, greater than, equal to, or between passed date(s)
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_education_get

Get all education details Parameters:
ParameterTypeRequiredDefaultDescription
systemIdstringNoSystem Id
employeeIdstringNoEmployee Id
countrystringNoThe country value
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_emp_global_localization_element_get

Get all global employee localization fields added to UKG Pro Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringNoEmployee Id
companyIdstringNoCompany Id
createdstringNoUsed to find employee localization fields created less than, greater than, equal to, or between passed date(s)
effectivestringNoUsed to find employee localization fields effective less than, greater than, equal to, or between passed date(s)
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_emp_multiple_positions_get

Get Employee Multiple Positions Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringNoEmployee Id
companyIdstringNoCompany Id
jobCodestringNoJob Code
positionCodestringNoPosition Code
isPrimarystringNoIs Primary
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_extended_elements_get

Get Employee Extended Elements Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
dateTimeCreatedstringNoDate Time Created
dateTimeChangedstringNoDate Time Changed
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_compensation_details

Get all compensation details Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
primaryJobCodestringNoPrimary Job Code
jobGroupCodestringNoJob Group Code
jobTitlestringNoJob Title
payGroupCodestringNoPay Group Code
fullTimeOrPartTimeCodestringNoFull Time Or Part Time Code
salaryOrHourlyCodestringNoSalary Or Hourly Code
primaryShiftCodestringNoPrimary Shift Code
primaryShiftGroupCodestringNoPrimary Shift Group Code
dateInJobstringNoUsed to find date in job less than, greater than, equal to, or between passed date(s)
dateLastPaidstringNoUsed to find date last paid less than, greater than, equal to, or between passed date(s)
datePaidThrustringNoUsed to find date paid through less than, greater than, equal to, or between passed date(s)
isAutoAllocatedstringNoIs Auto Allocated
isAutoPaidstringNoIs Auto Paid
isSeasonalWorkerstringNoIs Seasonal Worker
isHighlyCompensatedstringNoIs Highly Compensated
isMultipleJobstringNoIs Multiple Job
performanceReviewRatingstringNoPerformance Review Rating
performanceReviewTypestringNoPerformance Review Type
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_compensation_details_employee_id

Get all compensation details by employee Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesEmployee Id

ukg-employee-core_get_personnel_v1_contacts

Get all details for a person assigned to an employee as a contact Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringNoEmployee Id
isActivestringNoIs Active
relationshipCodestringNoRelationship Code
contactIdstringNoContact Id
countryCodestringNoCountry Code
cobraIsActivestringNoCobra Is Active
cobraStatusstringNoCobra Status
isBeneficiarystringNoIs Beneficiary
isDependentstringNoIs Dependent
dateOfCobraEventstringNoUsed to find date of COBRA event less than, greater than, equal to, or between passed date(s)
statusAsOfDatestringNoUsed to find contact status as of date less than, greater than,equal to, or between passed date(s)
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_contacts_contact_id

Get all details for a single person assigned to an employee as a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesContact Id
employeeIdstringNoEmployee Id
isActivestringNoIs Active
relationshipCodestringNoRelationship Code
countryCodestringNoCountry Code
cobraIsActivestringNoCobra Is Active
cobraStatusstringNoCobra Status
isBeneficiarystringNoIs Beneficiary
isDependentstringNoIs Dependent
dateOfCobraEventstringNoUsed to find date of COBRA event less than, greater than, equal to, or between passed date(s)
statusAsOfDatestringNoUsed to find contact status as of date less than, greater than, equal to, or between passed date(s)
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_empl_multiple_jobs

Get employee multiple jobs details Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringNoEmployee Id
companyIdstringNoCompany Id
jobCodestringNoJob Code
isPrimaryJobstringNoIs Primary Job
jobIsInActivestringNoJob Is In Active
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_employee_demographic_details

Get Employee Demographic Details Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringNoEmployee Id
companyIdstringNoCompany Id
lastNamestringNoLast Name
emailAddressstringNoEmail Address
addressStatestringNoAddress State
addressCountrystringNoAddress Country
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_employee_job_history_details_system_id

Get a single job history detail record Parameters:
ParameterTypeRequiredDefaultDescription
systemIdstringYesSystem Id
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
isOrgChangestringNoIs Org Change
isJobChangestringNoIs Job Change
isRateChangestringNoIs Rate Change
isPromotionstringNoIs Promotion
jobEffectiveDatestringNoUsed to find job history effective date less than, greater than, equal to, or between passed date(s)
dateTimeCreatedstringNoUsed to find job history created less than, greater than, equal to, or between passed date(s)
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_employee_security_user_details

Get employee security user details Parameters:
ParameterTypeRequiredDefaultDescription
userNamestringNoUser Name
employeeIDstringNoEmployee ID
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_employment_details

Retrieve Employment Details Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
primaryJobCodestringNoPrimary Job Code
jobTitlestringNoJob Title
fullTimeOrPartTimeCodestringNoFull Time Or Part Time Code
primaryWorkLocationCodestringNoPrimary Work Location Code
primaryProjectCodestringNoPrimary Project Code
deductionGroupCodestringNoDeduction Group Code
earningGroupCodestringNoEarning Group Code
employeeTypeCodestringNoEmployee Type Code
employeeStatusCodestringNoEmployee Status Code
employeeNumberstringNoEmployee Number
supervisorIDstringNoSupervisor ID
originalHireDatestringNoOriginal Hire Date
lastHireDatestringNoLast Hire Date
dateOfTerminationstringNoDate Of Termination
dateOfRetirementstringNoDate Of Retirement
dateTimeCreatedstringNoDate Time Created
dateTimeChangedstringNoDate Time Changed
dateLastPayDatePaidstringNoDate Last Pay Date Paid
payGroupstringNoPay Group
isHomeCompanybooleanNoIs Home Company
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_international_employees_employee_id

Get a single employees international details Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesEmployee Id
countryCodestringNoCountry Code
effectiveDatestringNoEffective Date
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_person_details

Get all person details Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
lastNamestringNoLast Name
emailAddressstringNoEmail Address
addressStatestringNoAddress State
addressCountrystringNoAddress Country
cobraIsActivestringNoCobra Is Active
cobraStatusstringNoCobra Status
dateOfCobraEventstringNoUsed to find date of COBRA event less than, greater than, equal to, or between passed date(s)
dateTimeCreatedstringNoUsed to find person record created less than, greater than, equal to, or between passed date(s)
dateTimeChangedstringNoUsed to find person record changed less than, greater than, equal to, or between passed date(s)
nationalIdstringNoNational Id
nationalIdCountrystringNoNational Id Country
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_get_personnel_v1_person_details_employee_id

Get a single person detail record Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesEmployee Id

ukg-employee-core_get_personnel_v1_user_profile_details

Get all user profile details Parameters:
ParameterTypeRequiredDefaultDescription
masterCompanystringNoMaster Company
userStatusstringNoUser Status
userIdstringNoUser Id
roleIdstringNoRole Id
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_global_bank_get

Get all direct deposit details for global employees Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
employeeCountrystringNoEmployee Country
payGroupstringNoPay Group
dateModifiedstringNoUsed to find global employee’s direct deposit modified date less than, greater than, equal to, or between passed date(s)
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_ids

Employee ID Lookup Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]YesRequest body

ukg-employee-core_international_employee_get

Get international employee details for all employees Parameters:
ParameterTypeRequiredDefaultDescription
countryCodestringNoCountry Code
effectiveDatestringNoEffective Date
employeeIdstringNoEmployee Id
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_job_history_detail_get

Get all employee job history details Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
isOrgChangestringNoIs Org Change
isJobChangestringNoIs Job Change
isRateChangestringNoIs Rate Change
isPromotionstringNoIs Promotion
systemIdstringNoSystem Id
jobEffectiveDatestringNoUsed to find job history effective date less than, greater than, equal to, or between passed date(s)
dateTimeCreatedstringNoUsed to find job history created less than, greater than, equal to, or between passed date(s)
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_multi_phone_numbers_get

Get employee multiple phone numbers Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringNoEmployee Id
systemIdstringNoSystem Id
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_national_document_get

All employee national document details Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringNoContact Id
employeeIdstringNoEmployee Id
nationalDocumentIssuingCountryCodestringNoNational Document Issuing Country Code
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_position_report_get

Get Position Report Parameters:
ParameterTypeRequiredDefaultDescription
positionCodestringNoPosition Code
reportsToPositionCodestringNoReports To Position Code
effectiveStartDatestringNoEffective Start Date
effectiveStopDatestringNoEffective Stop Date
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_retrieve_employee_employment_details

Retrieve Employee Employment Details Parameters:
ParameterTypeRequiredDefaultDescription
companyIDstringNoThe unique identifier for the company associated with an employee.
employeeIDstringNoThe unique identifier for an employee within the organization.
primaryJobCodestringNoA code which refers to the primary job code assigned to the employee.
jobTitlestringNoThe official job title of the employee.
fullTimeOrPartTimeCodestringNoA code indicating whether the employee is full-time or part-time.
primaryWorkLocationCodestringNoA code indicating the primary work location.
primaryProjectCodestringNoA code indicating the primary project or assignment.
deductionGroupCodestringNoA code indicating the group of deductions.
earningGroupCodestringNoA code indicating the group of earnings.
employeeTypeCodestringNoA code indicating the type of employee.
employeeStatusCodestringNoA code representing the current status of the employee.
employeeNumberstringNoThe employee number or identifier.
supervisorIdstringNoThe unique identifier of the employee’s supervisor.
originalHireDatestringNohe date when the employee was originally hired.
lastHireDatestringNoThe most recent hire date (if rehired)
dateOfTerminationstringNoThe date an employee was terminated.
dateOfRetirementstringNoThe date an employee retired.
dateTimeCreatedstringNoThe date and time an employee record was created.
dateTimeChangedstringNoThe date and time an employee record was last changed.
dateLastPayDatePaidstringNoThe date of an employee’s most recently paid pay date.
payGroupstringNoA code representing the pay group or category.
isHomeCompanystringNoA Boolean indicator of whether or not the current company is the employee’s home company.
pageintegerNoThe page number of a paginated response set.
per_PageintegerNoThe number of results contained per page in a paginated response set.

ukg-employee-core_supervisor_details_get

Get Employee Supervisor Details Parameters:
ParameterTypeRequiredDefaultDescription
companyIdstringNoCompany Id
employeeIdstringNoEmployee Id
supervisorCompanyIdstringNoSupervisor Company Id
supervisorEmployeeIdstringNoSupervisor Employee Id
supervisorCompanyCodestringNoSupervisor Company Code
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page

ukg-employee-core_user_details_get_user_details

Get User Details Parameters:
ParameterTypeRequiredDefaultDescription
userNamestringNoUser Name
userStatusstringNoUser Status
employeeIdstringNoEmployee Id
pageintegerNoPage number for pagination
per_PageintegerNoNumber of results per page