UKG

App · 20 actions

Read UKG Pro HCM employee, employment, compensation and company configuration data.

Actions

ActionWhat it does
Get compensation details by employeeGet compensation details by employee.
Get person details by employeeGet person details by employee.
List audit detailsList audit details.
List company detailsList company details.
List compensation detailsList compensation details.
List compensation details by companyList compensation details by company.
List compensation details by company and employeeList compensation details by company and employee.
List employee demographic detailsList employee demographic details.
List employee security user detailsList employee security user details.
List employee supervisor detailsList employee supervisor details.
List employment detailsList employment details.
List employment details by companyList employment details by company.
List employment details by company and employeeList employment details by company and employee.
List jobsList jobs.
List locationsList locations.
List org levelsList org levels.
List person detailsList person details.
List person details by companyList person details by company.
List person details by company and employeeList person details by company and employee.
List user profile detailsList user profile details.

Get compensation details by employee

Get compensation details by employee.

Inputs

Employee idemployee_idtextRequired
employeeId.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "annualSalary": 0,
    "avgPayRateCurPer": 0,
    "bonusTotalHrs": 0,
    "bonusTotalOtHrs": 0,
    "companyID": "",
    "currencyCode": "",
    "dateInJob": "",
    "dateLastPaid": "",
    "dateLastWorked": "",
    "dateOfLastSalaryReview": "",
    "dateOfNextSalayrReview": "",
    "datePaidThru": "",
    "distributionCenterCode": "",
    "emplStatus": "",
    "employeeID": "",
    "fullTimeOrPartTimeCode": "",
    "hourlyPayRate": 0,
    "isAutoAllocated": false,
    "isAutoPaid": false,
    "isHighlyCompensated": false,
    "isMultipleJob": false,
    "isSeasonalWorker": false,
    "jobChangeReasonCode": "",
    "jobGroupCode": "",
    "jobSalaryGrade": "",
    "jobTitle": "",
    "numberOfPayments": 0,
    "otherRate1": 0,
    "otherRate2": 0,
    "otherRate3": 0,
    "otherRate4": 0,
    "payGroupCode": "",
    "payGroupDescription": "",
    "payPeriod": "",
    "payPeriodPayRate": 0,
    "payScaleCode": "",
    "performanceReviewRating": "",
    "performanceReviewType": "",
    "piecePayRate": 0,
    "primaryJobCode": "",
    "primaryShiftCode": "",
    "primaryShiftGroupCode": "",
    "salaryOrHourlyCode": "",
    "scheduledAnnualWorkHours": 0,
    "scheduledFullTimeEquivalency": 0,
    "scheduledPeriodWorkHours": 0,
    "totalAnnSalary": 0,
    "weeklyHours": 0,
    "weeklyPayRate": 0
  },
  "has_more": false,
  "next_cursor": null
}

Get person details by employee

Get person details by employee.

Inputs

Employee idemployee_idtextRequired
employeeId.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "additionalName1": "",
    "additionalName2": "",
    "addressCity": "",
    "addressCountry": "",
    "addressCounty": "",
    "addressId": "",
    "addressIsOnTaxBoundary": false,
    "addressLatitude": 0,
    "addressLine1": "",
    "addressLine2": "",
    "addressSms": "",
    "addressState": "",
    "addressZipCode": "",
    "chkCashingInstCode": "",
    "cobraExport": "",
    "cobraIsActive": false,
    "cobraNotes": "",
    "cobraReason": "",
    "cobraStatus": "",
    "cobraStatusDate": "",
    "communityBroadcastSmsCode": "",
    "companyId": "",
    "consentElectronicW2": false,
    "consentElectronicw2pr": false,
    "dateDeceased": "",
    "dateOfBirth": "",
    "dateOfCobraEvent": "",
    "dateOfCobraExport": "",
    "dateOfCobraLetter": "",
    "dateOfI9Expiration": "",
    "datetimeChanged": "",
    "datetimeCreated": "",
    "disabilityType": "",
    "emailAddress": "",
    "emailAddressAlternate": "",
    "employeeId": "",
    "ethnicDescription": "",
    "ethnicIDCode": "",
    "firstName": "",
    "formerName": "",
    "gender": "",
    "healthBloodType": "",
    "healthEyes": "",
    "healthHair": "",
    "healthHeightFeet": "",
    "healthHeightInches": "",
    "healthLastDonateDate": "",
    "healthWeight": 0,
    "homePhone": "",
    "homePhoneCountry": "",
    "homePhoneIsPrivate": false,
    "i9AlienNumber": "",
    "i9DocA": "",
    "i9DocB": "",
    "i9DocC": "",
    "i9Verified": false,
    "i9VisaExpirationDate": "",
    "i9VisaType": "",
    "i9WorkAuth": "",
    "isDisabled": false,
    "isMultiPayGroup": false,
    "isSmoker": false,
    "lastName": "",
    "lastNameNotSameAsSSCard": "",
    "maritalStatusCode": "",
    "middleName": "",
    "militaryBranchServed": "",
    "militaryEra": "",
    "militaryIsActiveWartimeVet": "",
    "militaryIsDisabledVet": "",
    "militaryIsMedalVet": "",
    "militaryIsOthEligVet": "",
    "militaryIsOthEligVetBasis": "",
    "militarySeparationDate": "",
    "militaryService": false,
    "nameFormer": "",
    "namePrefixCode": "",
    "nameSufixCode": "",
    "nationalId": "",
    "nationalIdCountry": "",
    "nationality1": "",
    "nationality2": "",
    "nationality3": "",
    "originCountry": "",
    "originLocation": "",
    "personId": "",
    "preferredName": "",
    "previousSSN": "",
    "smsApprovals": false,
    "smsPayNotification": false,
    "ssn": "",
    "ssnIsSuppressed": false,
    "userName": "",
    "w2IsDeceased": false
  },
  "has_more": false,
  "next_cursor": null
}

List audit details

List audit details. Returns one page; use the continuation value for more records.

Inputs

Start date timestart_date_timedate and timeRequired
startDateTime.
End date timeend_date_timedate and timeRequired
endDateTime.
Table nametable_nametextRequired
tableName.
Field namefield_nametextRequired
fieldName.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List company details

List company details. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtext
5 character value represents a UKG Pro HCM CompanyID
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List compensation details

List compensation details. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtext
companyId.
Employee idemployee_idtext
employeeId.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List compensation details by company

List compensation details by company. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtextRequired
companyId.
Employee idemployee_idtext
employeeId.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List compensation details by company and employee

List compensation details by company and employee. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtextRequired
companyId.
Employee idemployee_idtextRequired
employeeId.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List employee demographic details

List employee demographic details. Returns one page; use the continuation value for more records.

Inputs

Employee idemployee_idtext
employeeId.
Companycompany_idtext
companyId.
Last namelast_nametext
lastName.
Email addressemail_addresstext
emailAddress.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List employee security user details

List employee security user details. Returns one page; use the continuation value for more records.

Inputs

Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List employee supervisor details

List employee supervisor details. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtext
companyId.
Employee idemployee_idtext
employeeId.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List employment details

List employment details. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtext
companyId.
Employee idemployee_idtext
employeeId.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List employment details by company

List employment details by company. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtextRequired
companyId.
Employee idemployee_idtext
employeeId.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List employment details by company and employee

List employment details by company and employee. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtextRequired
companyId.
Employee idemployee_idtextRequired
employeeId.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List jobs

List jobs.

Inputs

None.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List locations

List locations.

Inputs

None.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List org levels

List org levels.

Inputs

None.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List person details

List person details. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtext
companyId.
Employee idemployee_idtext
employeeId.
Last namelast_nametext
lastName.
Email addressemail_addresstext
emailAddress.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List person details by company

List person details by company. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtextRequired
companyId.
Employee idemployee_idtext
employeeId.
Last namelast_nametext
lastName.
Email addressemail_addresstext
emailAddress.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List person details by company and employee

List person details by company and employee. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtextRequired
companyId.
Employee idemployee_idtextRequired
employeeId.
Last namelast_nametext
lastName.
Email addressemail_addresstext
emailAddress.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List user profile details

List user profile details. Returns one page; use the continuation value for more records.

Inputs

Companycompany_idtext
companyId.
Employee idemployee_idtext
employeeId.
Pagepagenumber
page.From 1 to 2147483647.
Per pageper_pagenumber
per_Page.From 1 to 1000.

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

On this page