JUMP TOwelcomeWelcome to the UKG Pro APIAudit DetailsAuditDetailsGet Audit Details DatagetBusiness Rules Import ToolBusinessRuleImportToolTakes an XML transaction and feeds it into the Business Rule Import ToolpostRetrieves the status of an Business Rule Import Tool transactiongetRetrieves the status of an Business Rule Import Tool transactiongetTakes an XML transaction and feeds it into the Business Rule Import Tool (Staging)postBussiness Structure StatusBusinessStructureStatusGets a list of Employees for which there is a change in business structuregetCode TablesCodeTablesGet Code Tables informationgetPost Code Tables informationpostCompany DetailsCompanyDetailsGet Company DetailsgetCompensation DetailsCompensationDetailsGet all compensation detailsgetGet all compensation details by companygetGet all compensation details by company and employeegetGet all compensation details by employeegetDeduction CodeEmpDeductionsGet employee deductionsgetDependent DeductionsDependentDeductionsGet Dependent DeductionsgetEarning History Based ElementsEarningsHistoryGet Earnings History Base ElementsgetEarnings CodeEarningsGet a list of all earnings configurationsgetGet list of earnings configurations filtered by Parameter including pagination paramsgetGet a specific earning configurationgetEmployee ChangeChanges By DateChanges By DategetEmployee ChangesChanges By Employee IDgetEmployee Cobra DetailsEmployeeCobraDetailsGet Employee Cobra DetailsgetEmployee Contact DetailsContactGet all details for a person assigned to an employee as a contactgetGet all details for a single person assigned to an employee as a contactgetEmployee Contract DetailsEmployeeContractGet all employment contract detailsgetEmployee Deduction Benefit Option Change DateEmpDedBenOptionDateGet Employee Deduction Benefit Option Change DategetEmployee Deduction History Effective Change DateEmployee Deduction History Effective DateDeductions History Effective Change DategetEmployee DeductionEmpDeductionsGet employee deductionsgetEmployee Demographic DetailsEmployee Demographic DetailsGet Employee Demographic DetailsgetEmployee Direct Deposit DetailsDirectDepositGet list of direct deposit details for US and Canadian employeesgetGet list of direct deposit details for US and Canadian employees by companygetEmployee EducationEmployeeEducationGet all education detailsgetEmployee Employment DetailsEmployeeEmploymentDetailsGet Employee Employment DetailsgetEmployee Extended ElementsEmployeeExtendedElementsGet Employee Extended ElementsgetEmployee Job HistoryEmployeeJobHistoryDetailGet all employee job history detailsgetGet a single job history detail recordgetEmployee LookupEmployee ID LookupEmployee ID LookuppostEmployee Multiple JobsEmployeeMultipleJobsOPPGet employee multiple jobs detailsgetEmployee Multiple Phone NumbersEmployeeMultiPhoneNumbersGet employee multiple phone numbersgetEmployee Multiple PositionsEmpMultiplePositionsGet Employee Multiple PositionsgetEmployee National DocumentsNationalDocumentAll employee national document detailsgetEmployee Pay StatementCompanyPayStatementGet employee(s) pay statement(s) summary for a company or pay group for a given date range.postGet employee(s) pay statement(s) for a company or pay group for a given date range.postEmployeePayStatementGet employee pay statement(s) based on the passed employee identifier for a given date range.postGet employee last pay statement based on the passed employee identifier.postGet employee pay statement based on the given pay identifier.getEmployee ProfileKronosEmployeeProfilesGet list of employees profilegetEmployee Security User DetailsEmployee Security User DetailsGet employee security user detailsgetEmployee StatusKronosEmployeeStatusGet Employee StatusgetEmployee Supervisor DetailsEmployeeSupervisorDetailsGet Employee Supervisor DetailsgetEmployment DetailsEmploymentDetailsGet Employment DetailsgetGet Employment DetailsgetGet Employment DetailsgetGeneral Ledger Run DetailsGeneralLedgerRunDetailsV2Returns a list of details for a general ledger run, filterable by runId and blockIdgetReturns a list of details for a general ledger run, filterable by runId and blockIdgetGlobal Employee Direct DepositEmployeeGlobalBankGet all direct deposit details for global employeesgetGlobal Employee Localization DetailsEmpGlobalLocalizationElementGet all global employee localization fields added to UKG ProgetGlobal Employee Payments And DeductionsEmployeePayDeductionElementGet Global Employee Payments and Deductions ServicegetImport ToolImportToolTakes an XML transaction and feeds it into the Import ToolpostRetrieves the status of an import tool transactiongetInsurance RateInsRateGet Insurance RategetIntegration Audit ConfigurationIntegrationAuditConfigurationGet Integration Audit Configuration DatagetInternational EmployeesInternationalEmployeeGet international employee details for all employeesgetGet a single employees international detailsgetJob GroupJobGroupGet All Job GroupsgetJobs ConfigurationJobsRetrieve all jobs configurationsgetRetrieve a single job configurationgetLocations ConfigurationLocationsRetrieve all locations configurationsgetRetrieve a single location configurationgetOn Demand Pay Hours WorkedTimeAdd hours worked entriespostOnboarding New HireNew HiresGets a single New Hire by IdgetCreates a single New HirepostOnboarding and Recruiting Authorization TokenPost new token requestObtain New oAuth TokenpostOpen Enrollment Dependent DeductionsOpenEnrollmentDependentDeductionsGet Open Enrollment Dependent Deductions DatagetOpen Enrollment Employee DeductionsOpenEnrollmentEmployeeDeductionsGet Open Enrollment Employee DeductionsgetOption RateOptionRateGet Option Rate DatagetOrganization LevelsSingle Organization LevelGet single org-levelgetPatch one org-levelpatchUpdate one org-levelputView or Create Organization LevelsGet all org-levelsgetCreate org-level configurationpostOrganization Reporting CategoryOrganization Reporting CategoryGet Organization Reporting CategorygetPay RegisterPayRegisterGet Pay RegistergetPayGroup PayPeriodsPayGroupPayPeriodGet PayGroup PayPeriodsgetPayroll Deductions HistoryPayrollDeductionsHistoryGet Payroll Deductions HistorygetPayroll Earnings ImportEarningsImport Earnings for PayrollpostDelete Earning by IDdeleteRetrieve Earning by IDgetPerson DetailsPersonDetailsGet all person detailsgetGet all person details for a single companygetGet a single person detail record for a single companygetGet a single person detail recordgetPlatform Configuration Fields DataV1 PlatformConfigurationCustomFieldsDataPlatform Configuration Fields Data v1getV2 PlatformConfigurationCustomFieldsDataPlatform Configuration Fields Data v2getPlatform Configuration Fields SchemaPlatformConfigurationCustomFieldsSchemaGets Platform Configuration standard classes custom fields schemagetPosition ReportPositionReportGet Position ReportgetPositionsPositionsReturns list of employee position information filtered on various parametersgetPto PlansGet All PTO PlansGet all pto-plansgetPTO Plan PostCreate A PTO PlanpostPTO Plan PatchPatch one PTO PlanpatchGet Specific PTO PlanGet a specific pto-plangetGet Specific Employees PTO PlansGet a specific employees pto-plansgetRecruitingApplicationsRetrieve ApplicationsgetCreate ApplicationpostRetrieve Application by IDgetUpload Application DocumentpostRetrieve Comments by Application IDgetCreate Comment by Application IDpostInitiate Hire by Application IDpostLook Up EasyApply Application by Candidate, Opportunity, and Integration IDpostApplication Disposition EventsRetrieve Application Disposition Events by Application IDgetDisposition Application by IDpostRetrieve Application Disposition EventsgetBackground ChecksRetrieve Background Check Order RequestgetCreate Background CheckpostRetrieve Multiple Background ChecksgetRetrieve Background Check By IDgetUpdate Background CheckputRetrieve Background Check Results RequestgetCandidatesRetrieve CandidatesgetCreate CandidatepostRetrieve Candidate by IDgetRetrieve Name and Email by Candidate IDgetRetrieve Candidate by EmailpostUpload Document by Candidate IDpostRetrieve Comments by Candidate IDgetAdd Comment by Candidate IDpostRetrieve Behaviors by Candidate IDgetAdd Behavior by Candidate IDpostRetrieve Educations by Candidate IDgetAdd Education by Candidate IDpostRetrieve Motivations by Candidate IDgetAdd Motivation by Candidate IDpostRetrieve Licenses by Candidate IDgetAdd License by Candidate IDpostRetrieve Skills by Candidate IDgetAdd Skill by Candidate IDpostRetrieve References by Candidate IDgetAdd Reference by Candidate IDpostRetrieve Candidate Reference by IDgetUpdate Candidate Reference by IDputRetrieve Work Experiences by Candidate IDgetAdd Work Experience by Candidate IDpostConfiguration and SettingsRetrieve All Applicant SourcesgetCreate Applicant SourcepostRetrieve Applicant Source by IDgetRetrieve All BehaviorsgetCreate BehaviorpostRetrieve Behavior by IDgetArchive or Unarchive Behavior by IDpatchRetrieve All Disposition ReasonsgetCreate Disposition ReasonpostRetrieve Disposition Reason by IDgetRetrieve All Fields of StudygetRetrieve Field of Study by IDgetRetrieve All Job BoardsgetRetrieve Job Board by IDgetRetrieve All Legal EntitiesgetRetrieve Legal Entity by IDgetRetrieve All MotivationsgetCreate MotivationpostRetrieve Motivation by IDgetArchive or Unarchive Motivation by IDpatchRetrieve Physical LocationsgetCreate Physical LocationpostRetrieve Physical Location by IDgetArchive or Unarchive Physical Location by IDpatchRetrieve All PrefixesgetRetrieve Prefix by IDgetRetrieve All Proficiency LevelsgetRetrieve Proficiency Level by IDgetRetrieve All Recruiting ProcessesgetRetrieve Recruiting Process By IDgetRetrieve All SuffixesgetRetrieve Suffix By IDgetRetrieve All Tax LocationsgetRetrieve Tax Location by IDgetRetrieve Org UnitsgetRetrieve Org Unit by IDgetOffersRetrieve OffersgetCreate OfferpostRetrieve Offer Actions by Offer IDgetSubmit Offer for Approval by IDpostOpportunitiesRetrieve OpportunitiesgetCreate OpportunitypostRetrieve Opportunity by IDgetRetrieve Opportunity Country QuestionsgetRetrieve Opportunity Assessment by IDgetUpdate Opportunity Assessment by IDputDelete Opportunity Assessment by IDdeleteRetrieve All Opportunity AssessmentsgetCreate Opportunity AssessmentpostPublish Opportunity by IDpostClose Opportunity by IDpostRefresh Opportunity by IDpostCreate Opportunity Screening QuestionpostRetrieve Opportunity Screening QuestionsgetUpdate Opportunity Screening Question by IDputDeactivate Opportunity Screening QuestionspatchPrehire Assessments and WOTC SurveysRetrieve Assessment by IDgetUpdate Assessment by IDputCreate Assessment by IDpostRetrieve Assessments by Candidate IDgetThird Party Job SitesRetrieve Third Party Job Site Postings by Integration IDgetRetrieve Application Disposition Events by Third Party Job Site Integration IDgetRolesRolesGetGets Roles from security roles tablegetShift CodesShiftCodeShift Codes API DatagetTax Groups DetailsTax GroupsGet all tax group detailsgetThird Party Job BoardsGet Job PostingsGet job postingsgetTime And Attendance Schedule ImportActivitiesObtains all activities.getAssigned HolidaysObtains all assigned holidays.getEmployee JobsObtains all jobs for an employee.getEmployeesObtains all employees.getHour TypesObtains all hour types.getSchedule DetailsPublish schedule details.putTeamsObtains all teams.getTime CodesObtains all time codes.getTime Off RequestsObtains all time off requests.getUTA EmployeeObtains a UTA Employee by coId and eeId.getUTA Time ClockTimeGet processed clock transactions.getGet pending clock transactions.getObtain work summaries.getObtain a work summary.getUkg Pro CodesAllergyRetrieve all allergy configurationsgetCreate a new allergy configurationpostUpdate a single allergy configurationputAwardTypeRetrieve all awardType configurationsgetCreate a new awardType configurationpostUpdate a single awardType configurationputCareer ProviderRetrieve all careerProvider configurationsgetCreate a new careerProvider configurationpostUpdate a single careerProvider configurationputChildSupportTypeRetrieve all childSupportType configurationsgetCreate a new childSupportType configurationpostUpdate a single childSupportType configurationputCobraStatusRetrieve all cobraStatus configurationsgetCreate a new cobraStatus configurationpostUpdate a single cobraStatus configurationputCompanyPropertyRetrieve all companyProperty configurationsgetCreate a new companyProperty configurationpostUpdate a single companyProperty configurationputCourseCategoryRetrieve all courseCategory configurationsgetCreate a new courseCategory configurationpostUpdate a single courseCategory configurationputCourseDeliveryMetRetrieve all courseDeliveryMet configurationsgetCreate a new courseDeliveryMet configurationpostUpdate a single courseDeliveryMet configurationputCourseSubCategoryRetrieve all courseSubCategory configurationsgetCreate a new courseSubCategory configurationpostUpdate a single courseSubCategory configurationputDisabilityRetrieve all disability configurationsgetCreate a new disability configurationpostUpdate a single disability configurationputEmployeeTypeRetrieve all employeeType configurationsgetCreate a new employeeType configurationpostUpdate a single employeeType configurationputJobFamilyRetrieve all jobFamily configurationsgetCreate a new jobFamily configurationpostUpdate a single jobFamily configurationputLicenseTypeRetrieve all licenseType configurationsgetCreate a new licenseType configurationpostUpdate a single licenseType configurationputLoanTypeRetrieve all loanType configurationsgetCreate a new loanType configurationpostUpdate a single loanType configurationputMaritalStatusRetrieve all maritalStatus configurationsgetCreate a new maritalStatus configurationpostUpdate a single maritalStatus configurationputMilitaryBranchesRetrieve all militaryBranches configurationsgetCreate a new militaryBranches configurationpostUpdate a single militaryBranches configurationputMilitaryEraRetrieve all militaryEra configurationsgetCreate a new militaryEra configurationpostUpdate a single militaryEra configurationputNamePrefixRetrieve all namePrefix configurationsgetCreate a new namePrefix configurationpostUpdate a single namePrefix configurationputOtherPhoneTypesRetrieve all otherPhoneTypes configurationsgetCreate a new otherPhoneTypes configurationpostUpdate a single otherPhoneTypes configurationputProjectRetrieve all Project configurationsgetCreate a new project configurationpostUpdate a single project configurationputSchoolRetrieve all school configurationsgetCreate a new school configurationpostUpdate a single school configurationputSkillProficiencyLevelRetrieve all skillProficiencyLevel configurationsgetCreate a new skillProficiencyLevel configurationpostUpdate a single skillProficiencyLevel configurationputSkillsRetrieve all skills configurationsgetCreate a new skills configurationpostUpdate a single skills configurationputTermTypeRetrieve all termType configurationsgetCreate a new termType configurationpostUpdate a single termType configurationputWaiveReasonRetrieve all waiveReason configurationsgetCreate a new waiveReason configurationpostUpdate a single waiveReason configurationputUser Defined FieldsUserDefinedFieldsGet User Defined FieldsgetGet User Defined Fields for single companygetGet User Defined Fields for a single employee in a single companygetUser DetailsUserDetailsGet User DetailsgetUser PreferencesUser PreferencesGet User Preferences DetailsgetUser Profile DetailsUser Profile DetailsGet all user profile detailsgetCreates a single New Hirepost https://{tenantId}.{hostname}/tenants/{tenantIdentifier}/new-hiresCreates a single New Hire
