Guides
Signup For Free

UKG Pro API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for UKG Pro API as part of the HRIS category

Get All Teams

  • ID: get_all_teams
  • Operation: read
  • Entities: entity, team
  • Summary: This API endpoint retrieves all teams. It requires a GET request to the URL https://{hostname}/simpleschedule/teams. The request must include the 'US-CUSTOMER-API-KEY' header, which is a unique API key for each Pro HR Tenant. Optional query parameters 'index' and 'max' can be used for pagination, where 'index' specifies the starting point and 'max' specifies the maximum number of elements per page. The response includes a list of team entities, each with an 'id', 'wbtName', and 'wbtDesc', along with the 'index' and 'requestedCount' indicating the pagination details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Compensation Details by Employee

  • ID: get_compensation_details_by_employee
  • Operation: read
  • Entities: compensation detail, company, employee
  • Summary: This API retrieves all compensation details for a specified employee. It requires the employee ID as a path parameter and supports optional date filters in the query parameters. The request must include headers for 'US-CUSTOMER-API-KEY' and 'Authorization'. The response includes detailed compensation information such as salary, pay rates, job codes, and employment status. The API supports various date-time operators for filtering job start dates.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Employment Details

  • ID: get_employee_employment_details
  • Operation: read
  • Entities: job, company, employee
  • Summary: The Get Employee Employment Details API retrieves detailed employment information for employees. It requires the 'US-CUSTOMER-API-KEY' and 'Authorization' headers for authentication. The API supports various query parameters such as 'companyID', 'employeeID', 'primaryJobCode', 'jobTitle', and more, allowing for filtering of results. The response includes detailed employment data such as 'companyID', 'employeeID', 'primaryJobCode', 'annualSalary', 'jobTitle', and other employment-related attributes. If no pagination parameters are specified, default values are applied. The API requires the UKG Pro service account to have the 'View' role for the 'Personnel Integration' Web Service.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Multiple Positions

  • ID: get_employee_multiple_positions
  • Operation: read
  • Entities: personnel, position, employee
  • Summary: This API retrieves multiple positions for employees. It requires the 'US-CUSTOMER-API-KEY' and 'Authorization' headers. Optional query parameters include 'employeeId', 'companyId', 'jobCode', 'positionCode', 'isPrimary', 'page', and 'per_Page'. The response includes detailed information about each position, such as 'employeeId', 'companyId', 'jobCode', 'positionCode', 'isPrimary', 'annualSalary', 'hourlyPayRate', and more. If no pagination parameters are specified, default values are applied. The API requires the UKG Pro service account to have the 'View' role for the 'Personnel Integration' Web Service.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employee Supervisor Details

  • ID: get_employee_supervisor_details
  • Operation: read
  • Entities: supervisor, company, employee
  • Summary: This API retrieves the details of employees and their supervisors. It requires the 'US-CUSTOMER-API-KEY' and 'Authorization' headers for authentication. The API supports various query parameters such as 'companyId', 'employeeId', 'supervisorCompanyId', 'supervisorEmployeeId', 'supervisorCompanyCode', 'page', and 'per_Page' to filter and paginate the results. The response includes details like employee ID, company ID, supervisor's first and last name, email, work phone, and other related information. If no pagination parameters are specified, default values are applied.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employment Record Details by Company

  • ID: get_employment_record_details_by_company
  • Operation: read
  • Entities: employment record, employee, company
  • Summary: This API endpoint retrieves all employment record details for a specified company. It requires a valid company ID as a path parameter and supports various optional query parameters such as employeeId, jobTitle, and pagination options like page and per_Page. The request must include headers for US-CUSTOMER-API-KEY and Authorization. The response is an array of employment records in JSON format, including detailed fields such as companyID, employeeID, jobDescription, and various date fields. If no pagination parameters are specified, a default maximum is applied. The API requires the UKG Pro service account to have a 'View' role for the 'Personnel Integration' Web Service.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Master and Component Company Details

  • ID: get_master_and_component_company_details
  • Operation: read
  • Entities: company, address, organization level
  • Summary: This API endpoint retrieves all master company and component company details from the UKG Pro system. It supports optional query parameters such as companyId, masterCompanyId, companyCode, isMasterCompany, page, and per_Page for filtering and pagination. The request requires headers including the US-CUSTOMER-API-KEY and Authorization. The response returns an array of company details, including fields like companyID, companyCode, companyName, address, phone number, and organizational levels.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Person Details for a Company Employee

  • ID: get_person_details_for_a_company_employee
  • Operation: read
  • Entities: company, employee, person detail
  • Summary: This API endpoint retrieves a single person detail record for a specific employee within a company. It requires the company ID and employee ID as path parameters. The API supports various query parameters for filtering, such as lastName, emailAddress, addressState, and more. It also supports date-time filtering for fields like dateOfCobraEvent, dateTimeCreated, and dateTimeChanged. The request must include headers for US-CUSTOMER-API-KEY and Authorization. The response includes detailed information about the employee, such as personal details, address, military service, and more. The API requires the UKG Pro service account to have the 'View' role for the 'Employee Person Details' Web Service.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Time Off Requests

  • ID: get_time_off_requests
  • Operation: read
  • Entities: day, employee, time off request
  • Summary: The Get Time Off Requests API endpoint allows users to obtain all time off requests within a specified date range. The API requires a GET request to the endpoint https://{hostname}/simpleschedule/timeoff_requests. It accepts query parameters such as 'emp_name' (optional), 'emp_id' (optional), 'from' (required, start range for requests), and 'to' (required, end range for requests). Additionally, a required header 'US-CUSTOMER-API-KEY' must be provided for authentication. The response includes a list of time off request entities, each containing details such as request ID, type, comment, days, status, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get UltiPro Employee PTO Plans

  • ID: get_ultipro_employee_pto_plans
  • Operation: read
  • Entities: employee, company, pto plan
  • Summary: This API endpoint retrieves information about an UltiPro employee's PTO (Paid Time Off) plans. It requires the 'View' role for the 'PTO Plan Integration' Web Service. The request must include the 'US-CUSTOMER-API-KEY' and 'Authorization' headers. The 'companyId' and 'employeeId' are required path parameters. Optional query parameters 'page' and 'per_page' can be used for pagination. The response includes details such as the employee's PTO plan, earned and taken PTO, pending balance, and relevant dates.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get UltiPro Location Configuration

  • ID: get_ultipro_location_configuration
  • Operation: read
  • Entities: location, company configuration, location code
  • Summary: The Get UltiPro Location Configuration API endpoint retrieves information about a specific UltiPro location configuration identified by the 'code' path parameter. The request requires headers including 'US-CUSTOMER-API-KEY' and 'Authorization' with base64 encoded credentials. The response includes details such as country code, location code, description, city, state, ZIP or postal code, and active status. Possible response codes include 200 (OK), 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), and 404 (Not Found).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Look up Employee ID/Company ID

  • ID: post_look_up_employee_id_company_id
  • Operation: write
  • Entities: company, identifier, employee
  • Summary: This API endpoint allows for the lookup of Employee ID and Company ID using a POST request due to the sensitive nature of the lookup properties. It supports multiple records to be looked up in the request body as an array of Identifier objects. The request requires headers including 'US-CUSTOMER-API-KEY' and 'Authorization'. The request body must include 'employeeIdentifierType' and 'employeeIdentifierValue' as required fields. The response returns a multi-status array with details of each lookup, including success or error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Last Pay Statement for Employee

  • ID: post_retrieve_last_pay_statement_for_employee
  • Operation: read
  • Entities: employee, company, pay statement
  • Summary: This API endpoint allows you to retrieve the last pay statement for a specific employee by providing the employee identifier. It requires the 'View' role for the 'Employee Pay Statements' Web Service. The request must include headers such as US-CUSTOMER-API-KEY, US-Client-id, and Authorization for authentication. The request body should include the employee identifier details, start and end dates, and pagination information. The response includes detailed information about the employee's pay statement, including accruals, deductions, earnings, net pay, and taxes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Company Details for a Specific Employee

  • ID: retrieve_company_details_for_a_specific_employee
  • Operation: read
  • Entities: company
  • Summary: This configuration retrieves the company details for a specific employee. It first uses the 'Get Person Details for a Company Employee' API to obtain the companyId for the employee, and then uses the 'Get Master and Component Company Details' API to retrieve detailed company information. The input requires the employeeId and companyId, along with authentication headers. The output provides comprehensive details about the company, including its name, address, phone number, and organizational levels.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago