> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # ukg-employee-core > UKG Pro Employee Core - person details, compensation, employment, contacts, job history, and demographics **Server path:** `/ukg-employee-core` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | [`ukg-employee-core_changes_get`](#ukg-employee-core_changes_get) | Changes By Employee ID | | [`ukg-employee-core_changes_get_all`](#ukg-employee-core_changes_get_all) | Changes By Date | | [`ukg-employee-core_cobra_details_get`](#ukg-employee-core_cobra_details_get) | Get Employee Cobra Details | | [`ukg-employee-core_contract_get`](#ukg-employee-core_contract_get) | Get all employment contract details | | [`ukg-employee-core_education_get`](#ukg-employee-core_education_get) | Get all education details | | [`ukg-employee-core_emp_global_localization_element_get`](#ukg-employee-core_emp_global_localization_element_get) | Get all global employee localization fields added to UKG Pro | | [`ukg-employee-core_emp_multiple_positions_get`](#ukg-employee-core_emp_multiple_positions_get) | Get Employee Multiple Positions | | [`ukg-employee-core_extended_elements_get`](#ukg-employee-core_extended_elements_get) | Get Employee Extended Elements | | [`ukg-employee-core_get_personnel_v1_compensation_details`](#ukg-employee-core_get_personnel_v1_compensation_details) | Get all compensation details | | [`ukg-employee-core_get_personnel_v1_compensation_details_employee_id`](#ukg-employee-core_get_personnel_v1_compensation_details_employee_id) | Get all compensation details by employee | | [`ukg-employee-core_get_personnel_v1_contacts`](#ukg-employee-core_get_personnel_v1_contacts) | Get all details for a person assigned to an employee as a contact | | [`ukg-employee-core_get_personnel_v1_contacts_contact_id`](#ukg-employee-core_get_personnel_v1_contacts_contact_id) | Get all details for a single person assigned to an employee as a contact | | [`ukg-employee-core_get_personnel_v1_empl_multiple_jobs`](#ukg-employee-core_get_personnel_v1_empl_multiple_jobs) | Get employee multiple jobs details | | [`ukg-employee-core_get_personnel_v1_employee_demographic_details`](#ukg-employee-core_get_personnel_v1_employee_demographic_details) | Get Employee Demographic Details | | [`ukg-employee-core_get_personnel_v1_employee_job_history_details_system_id`](#ukg-employee-core_get_personnel_v1_employee_job_history_details_system_id) | Get a single job history detail record | | [`ukg-employee-core_get_personnel_v1_employee_security_user_details`](#ukg-employee-core_get_personnel_v1_employee_security_user_details) | Get employee security user details | | [`ukg-employee-core_get_personnel_v1_employment_details`](#ukg-employee-core_get_personnel_v1_employment_details) | Retrieve Employment Details | | [`ukg-employee-core_get_personnel_v1_international_employees_employee_id`](#ukg-employee-core_get_personnel_v1_international_employees_employee_id) | Get a single employees international details | | [`ukg-employee-core_get_personnel_v1_person_details`](#ukg-employee-core_get_personnel_v1_person_details) | Get all person details | | [`ukg-employee-core_get_personnel_v1_person_details_employee_id`](#ukg-employee-core_get_personnel_v1_person_details_employee_id) | Get a single person detail record | | [`ukg-employee-core_get_personnel_v1_user_profile_details`](#ukg-employee-core_get_personnel_v1_user_profile_details) | Get all user profile details | | [`ukg-employee-core_global_bank_get`](#ukg-employee-core_global_bank_get) | Get all direct deposit details for global employees | | [`ukg-employee-core_ids`](#ukg-employee-core_ids) | Employee ID Lookup | | [`ukg-employee-core_international_employee_get`](#ukg-employee-core_international_employee_get) | Get international employee details for all employees | | [`ukg-employee-core_job_history_detail_get`](#ukg-employee-core_job_history_detail_get) | Get all employee job history details | | [`ukg-employee-core_multi_phone_numbers_get`](#ukg-employee-core_multi_phone_numbers_get) | Get employee multiple phone numbers | | [`ukg-employee-core_national_document_get`](#ukg-employee-core_national_document_get) | All employee national document details | | [`ukg-employee-core_position_report_get`](#ukg-employee-core_position_report_get) | Get Position Report | | [`ukg-employee-core_retrieve_employee_employment_details`](#ukg-employee-core_retrieve_employee_employment_details) | Retrieve Employee Employment Details | | [`ukg-employee-core_supervisor_details_get`](#ukg-employee-core_supervisor_details_get) | Get Employee Supervisor Details | | [`ukg-employee-core_user_details_get_user_details`](#ukg-employee-core_user_details_get_user_details) | Get User Details | *** ## ukg-employee-core\_changes\_get Changes By Employee ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------- | | `employeeId` | string | Yes | — | Employee Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" } }, "required": [ "PCID", "employeeId" ] } ``` *** ## ukg-employee-core\_changes\_get\_all Changes By Date **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------------------------- | | `startDate` | string | No | — | Used to lookup employee changes within time span | | `endDate` | string | No | — | Used to lookup employee changes within time span | | `page` | number | No | — | Pagination, which page you want to see | | `per_page` | number | No | — | Pagination, how many records per page you want to see | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "startDate": { "type": "string", "description": "Used to lookup employee changes within time span" }, "endDate": { "type": "string", "description": "Used to lookup employee changes within time span" }, "page": { "type": "number", "description": "Pagination, which page you want to see" }, "per_page": { "type": "number", "description": "Pagination, how many records per page you want to see" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_cobra\_details\_get Get Employee Cobra Details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | -------------------------- | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `cobraIsActive` | boolean | No | — | Cobra Is Active | | `cobraStatus` | string | No | — | Cobra Status | | `dateOfCobraEvent` | string | No | — | Date Of Cobra Event | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "cobraIsActive": { "type": "boolean", "description": "Cobra Is Active" }, "cobraStatus": { "type": "string", "description": "Cobra Status" }, "dateOfCobraEvent": { "type": "string", "description": "Date Of Cobra Event" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_contract\_get Get all employment contract details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `contractNumber` | string | No | — | Contract Number | | `contractTypeCode` | string | No | — | Contract Type Code | | `effectiveDate` | string | No | — | Used to find contracts effective date less than, greater than, equal to, or between passed date(s) | | `dateTimeCreated` | string | No | — | Used to find contract record created date less than, greater than, equal to, or between passed date(s) | | `rowLastChanged` | string | No | — | Used to find contract record changed date less than, greater than, equal to, or between passed date(s) | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "contractNumber": { "type": "string", "description": "Contract Number" }, "contractTypeCode": { "type": "string", "description": "Contract Type Code" }, "effectiveDate": { "type": "string", "description": "Used to find contracts effective date less than, greater than, equal to, or between passed date(s)" }, "dateTimeCreated": { "type": "string", "description": "Used to find contract record created date less than, greater than, equal to, or between passed date(s)" }, "rowLastChanged": { "type": "string", "description": "Used to find contract record changed date less than, greater than, equal to, or between passed date(s)" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_education\_get Get all education details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------- | | `systemId` | string | No | — | System Id | | `employeeId` | string | No | — | Employee Id | | `country` | string | No | — | The country value | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "systemId": { "type": "string", "description": "System Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "country": { "type": "string", "description": "The country value" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_emp\_global\_localization\_element\_get Get all global employee localization fields added to UKG Pro **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `employeeId` | string | No | — | Employee Id | | `companyId` | string | No | — | Company Id | | `created` | string | No | — | Used to find employee localization fields created less than, greater than, equal to, or between passed date(s) | | `effective` | string | No | — | Used to find employee localization fields effective less than, greater than, equal to, or between passed date(s) | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" }, "companyId": { "type": "string", "description": "Company Id" }, "created": { "type": "string", "description": "Used to find employee localization fields created less than, greater than, equal to, or between passed date(s)" }, "effective": { "type": "string", "description": "Used to find employee localization fields effective less than, greater than, equal to, or between passed date(s)" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_emp\_multiple\_positions\_get Get Employee Multiple Positions **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | -------------------------- | | `employeeId` | string | No | — | Employee Id | | `companyId` | string | No | — | Company Id | | `jobCode` | string | No | — | Job Code | | `positionCode` | string | No | — | Position Code | | `isPrimary` | string | No | — | Is Primary | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" }, "companyId": { "type": "string", "description": "Company Id" }, "jobCode": { "type": "string", "description": "Job Code" }, "positionCode": { "type": "string", "description": "Position Code" }, "isPrimary": { "type": "string", "description": "Is Primary" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_extended\_elements\_get Get Employee Extended Elements **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------------- | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `dateTimeCreated` | string | No | — | Date Time Created | | `dateTimeChanged` | string | No | — | Date Time Changed | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "dateTimeCreated": { "type": "string", "description": "Date Time Created" }, "dateTimeChanged": { "type": "string", "description": "Date Time Changed" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_compensation\_details Get all compensation details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------- | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `primaryJobCode` | string | No | — | Primary Job Code | | `jobGroupCode` | string | No | — | Job Group Code | | `jobTitle` | string | No | — | Job Title | | `payGroupCode` | string | No | — | Pay Group Code | | `fullTimeOrPartTimeCode` | string | No | — | Full Time Or Part Time Code | | `salaryOrHourlyCode` | string | No | — | Salary Or Hourly Code | | `primaryShiftCode` | string | No | — | Primary Shift Code | | `primaryShiftGroupCode` | string | No | — | Primary Shift Group Code | | `dateInJob` | string | No | — | Used to find date in job less than, greater than, equal to, or between passed date(s) | | `dateLastPaid` | string | No | — | Used to find date last paid less than, greater than, equal to, or between passed date(s) | | `datePaidThru` | string | No | — | Used to find date paid through less than, greater than, equal to, or between passed date(s) | | `isAutoAllocated` | string | No | — | Is Auto Allocated | | `isAutoPaid` | string | No | — | Is Auto Paid | | `isSeasonalWorker` | string | No | — | Is Seasonal Worker | | `isHighlyCompensated` | string | No | — | Is Highly Compensated | | `isMultipleJob` | string | No | — | Is Multiple Job | | `performanceReviewRating` | string | No | — | Performance Review Rating | | `performanceReviewType` | string | No | — | Performance Review Type | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "primaryJobCode": { "type": "string", "description": "Primary Job Code" }, "jobGroupCode": { "type": "string", "description": "Job Group Code" }, "jobTitle": { "type": "string", "description": "Job Title" }, "payGroupCode": { "type": "string", "description": "Pay Group Code" }, "fullTimeOrPartTimeCode": { "type": "string", "description": "Full Time Or Part Time Code" }, "salaryOrHourlyCode": { "type": "string", "description": "Salary Or Hourly Code" }, "primaryShiftCode": { "type": "string", "description": "Primary Shift Code" }, "primaryShiftGroupCode": { "type": "string", "description": "Primary Shift Group Code" }, "dateInJob": { "type": "string", "description": "Used to find date in job less than, greater than, equal to, or between passed date(s)" }, "dateLastPaid": { "type": "string", "description": "Used to find date last paid less than, greater than, equal to, or between passed date(s)" }, "datePaidThru": { "type": "string", "description": "Used to find date paid through less than, greater than, equal to, or between passed date(s)" }, "isAutoAllocated": { "type": "string", "description": "Is Auto Allocated" }, "isAutoPaid": { "type": "string", "description": "Is Auto Paid" }, "isSeasonalWorker": { "type": "string", "description": "Is Seasonal Worker" }, "isHighlyCompensated": { "type": "string", "description": "Is Highly Compensated" }, "isMultipleJob": { "type": "string", "description": "Is Multiple Job" }, "performanceReviewRating": { "type": "string", "description": "Performance Review Rating" }, "performanceReviewType": { "type": "string", "description": "Performance Review Type" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_compensation\_details\_employee\_id Get all compensation details by employee **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------- | | `employeeId` | string | Yes | — | Employee Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" } }, "required": [ "PCID", "employeeId" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_contacts Get all details for a person assigned to an employee as a contact **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------- | | `employeeId` | string | No | — | Employee Id | | `isActive` | string | No | — | Is Active | | `relationshipCode` | string | No | — | Relationship Code | | `contactId` | string | No | — | Contact Id | | `countryCode` | string | No | — | Country Code | | `cobraIsActive` | string | No | — | Cobra Is Active | | `cobraStatus` | string | No | — | Cobra Status | | `isBeneficiary` | string | No | — | Is Beneficiary | | `isDependent` | string | No | — | Is Dependent | | `dateOfCobraEvent` | string | No | — | Used to find date of COBRA event less than, greater than, equal to, or between passed date(s) | | `statusAsOfDate` | string | No | — | Used to find contact status as of date less than, greater than,equal to, or between passed date(s) | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" }, "isActive": { "type": "string", "description": "Is Active" }, "relationshipCode": { "type": "string", "description": "Relationship Code" }, "contactId": { "type": "string", "description": "Contact Id" }, "countryCode": { "type": "string", "description": "Country Code" }, "cobraIsActive": { "type": "string", "description": "Cobra Is Active" }, "cobraStatus": { "type": "string", "description": "Cobra Status" }, "isBeneficiary": { "type": "string", "description": "Is Beneficiary" }, "isDependent": { "type": "string", "description": "Is Dependent" }, "dateOfCobraEvent": { "type": "string", "description": "Used to find date of COBRA event less than, greater than, equal to, or between passed date(s)" }, "statusAsOfDate": { "type": "string", "description": "Used to find contact status as of date less than, greater than,equal to, or between passed date(s)" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_contacts\_contact\_id Get all details for a single person assigned to an employee as a contact **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------- | | `contactId` | string | Yes | — | Contact Id | | `employeeId` | string | No | — | Employee Id | | `isActive` | string | No | — | Is Active | | `relationshipCode` | string | No | — | Relationship Code | | `countryCode` | string | No | — | Country Code | | `cobraIsActive` | string | No | — | Cobra Is Active | | `cobraStatus` | string | No | — | Cobra Status | | `isBeneficiary` | string | No | — | Is Beneficiary | | `isDependent` | string | No | — | Is Dependent | | `dateOfCobraEvent` | string | No | — | Used to find date of COBRA event less than, greater than, equal to, or between passed date(s) | | `statusAsOfDate` | string | No | — | Used to find contact status as of date less than, greater than, equal to, or between passed date(s) | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contactId": { "type": "string", "description": "Contact Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "isActive": { "type": "string", "description": "Is Active" }, "relationshipCode": { "type": "string", "description": "Relationship Code" }, "countryCode": { "type": "string", "description": "Country Code" }, "cobraIsActive": { "type": "string", "description": "Cobra Is Active" }, "cobraStatus": { "type": "string", "description": "Cobra Status" }, "isBeneficiary": { "type": "string", "description": "Is Beneficiary" }, "isDependent": { "type": "string", "description": "Is Dependent" }, "dateOfCobraEvent": { "type": "string", "description": "Used to find date of COBRA event less than, greater than, equal to, or between passed date(s)" }, "statusAsOfDate": { "type": "string", "description": "Used to find contact status as of date less than, greater than, equal to, or between passed date(s)" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "contactId" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_empl\_multiple\_jobs Get employee multiple jobs details **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `employeeId` | string | No | — | Employee Id | | `companyId` | string | No | — | Company Id | | `jobCode` | string | No | — | Job Code | | `isPrimaryJob` | string | No | — | Is Primary Job | | `jobIsInActive` | string | No | — | Job Is In Active | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" }, "companyId": { "type": "string", "description": "Company Id" }, "jobCode": { "type": "string", "description": "Job Code" }, "isPrimaryJob": { "type": "string", "description": "Is Primary Job" }, "jobIsInActive": { "type": "string", "description": "Job Is In Active" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_employee\_demographic\_details Get Employee Demographic Details **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | -------------------------- | | `employeeId` | string | No | — | Employee Id | | `companyId` | string | No | — | Company Id | | `lastName` | string | No | — | Last Name | | `emailAddress` | string | No | — | Email Address | | `addressState` | string | No | — | Address State | | `addressCountry` | string | No | — | Address Country | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" }, "companyId": { "type": "string", "description": "Company Id" }, "lastName": { "type": "string", "description": "Last Name" }, "emailAddress": { "type": "string", "description": "Email Address" }, "addressState": { "type": "string", "description": "Address State" }, "addressCountry": { "type": "string", "description": "Address Country" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_employee\_job\_history\_details\_system\_id Get a single job history detail record **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | | `systemId` | string | Yes | — | System Id | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `isOrgChange` | string | No | — | Is Org Change | | `isJobChange` | string | No | — | Is Job Change | | `isRateChange` | string | No | — | Is Rate Change | | `isPromotion` | string | No | — | Is Promotion | | `jobEffectiveDate` | string | No | — | Used to find job history effective date less than, greater than, equal to, or between passed date(s) | | `dateTimeCreated` | string | No | — | Used to find job history created less than, greater than, equal to, or between passed date(s) | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "systemId": { "type": "string", "description": "System Id" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "isOrgChange": { "type": "string", "description": "Is Org Change" }, "isJobChange": { "type": "string", "description": "Is Job Change" }, "isRateChange": { "type": "string", "description": "Is Rate Change" }, "isPromotion": { "type": "string", "description": "Is Promotion" }, "jobEffectiveDate": { "type": "string", "description": "Used to find job history effective date less than, greater than, equal to, or between passed date(s)" }, "dateTimeCreated": { "type": "string", "description": "Used to find job history created less than, greater than, equal to, or between passed date(s)" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "systemId" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_employee\_security\_user\_details Get employee security user details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------- | | `userName` | string | No | — | User Name | | `employeeID` | string | No | — | Employee ID | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userName": { "type": "string", "description": "User Name" }, "employeeID": { "type": "string", "description": "Employee ID" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_employment\_details Retrieve Employment Details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | --------------------------- | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `primaryJobCode` | string | No | — | Primary Job Code | | `jobTitle` | string | No | — | Job Title | | `fullTimeOrPartTimeCode` | string | No | — | Full Time Or Part Time Code | | `primaryWorkLocationCode` | string | No | — | Primary Work Location Code | | `primaryProjectCode` | string | No | — | Primary Project Code | | `deductionGroupCode` | string | No | — | Deduction Group Code | | `earningGroupCode` | string | No | — | Earning Group Code | | `employeeTypeCode` | string | No | — | Employee Type Code | | `employeeStatusCode` | string | No | — | Employee Status Code | | `employeeNumber` | string | No | — | Employee Number | | `supervisorID` | string | No | — | Supervisor ID | | `originalHireDate` | string | No | — | Original Hire Date | | `lastHireDate` | string | No | — | Last Hire Date | | `dateOfTermination` | string | No | — | Date Of Termination | | `dateOfRetirement` | string | No | — | Date Of Retirement | | `dateTimeCreated` | string | No | — | Date Time Created | | `dateTimeChanged` | string | No | — | Date Time Changed | | `dateLastPayDatePaid` | string | No | — | Date Last Pay Date Paid | | `payGroup` | string | No | — | Pay Group | | `isHomeCompany` | boolean | No | — | Is Home Company | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "primaryJobCode": { "type": "string", "description": "Primary Job Code" }, "jobTitle": { "type": "string", "description": "Job Title" }, "fullTimeOrPartTimeCode": { "type": "string", "description": "Full Time Or Part Time Code" }, "primaryWorkLocationCode": { "type": "string", "description": "Primary Work Location Code" }, "primaryProjectCode": { "type": "string", "description": "Primary Project Code" }, "deductionGroupCode": { "type": "string", "description": "Deduction Group Code" }, "earningGroupCode": { "type": "string", "description": "Earning Group Code" }, "employeeTypeCode": { "type": "string", "description": "Employee Type Code" }, "employeeStatusCode": { "type": "string", "description": "Employee Status Code" }, "employeeNumber": { "type": "string", "description": "Employee Number" }, "supervisorID": { "type": "string", "description": "Supervisor ID" }, "originalHireDate": { "type": "string", "description": "Original Hire Date" }, "lastHireDate": { "type": "string", "description": "Last Hire Date" }, "dateOfTermination": { "type": "string", "description": "Date Of Termination" }, "dateOfRetirement": { "type": "string", "description": "Date Of Retirement" }, "dateTimeCreated": { "type": "string", "description": "Date Time Created" }, "dateTimeChanged": { "type": "string", "description": "Date Time Changed" }, "dateLastPayDatePaid": { "type": "string", "description": "Date Last Pay Date Paid" }, "payGroup": { "type": "string", "description": "Pay Group" }, "isHomeCompany": { "type": "boolean", "description": "Is Home Company" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_international\_employees\_employee\_id Get a single employees international details **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `employeeId` | string | Yes | — | Employee Id | | `countryCode` | string | No | — | Country Code | | `effectiveDate` | string | No | — | Effective Date | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" }, "countryCode": { "type": "string", "description": "Country Code" }, "effectiveDate": { "type": "string", "description": "Effective Date" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID", "employeeId" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_person\_details Get all person details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------- | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `lastName` | string | No | — | Last Name | | `emailAddress` | string | No | — | Email Address | | `addressState` | string | No | — | Address State | | `addressCountry` | string | No | — | Address Country | | `cobraIsActive` | string | No | — | Cobra Is Active | | `cobraStatus` | string | No | — | Cobra Status | | `dateOfCobraEvent` | string | No | — | Used to find date of COBRA event less than, greater than, equal to, or between passed date(s) | | `dateTimeCreated` | string | No | — | Used to find person record created less than, greater than, equal to, or between passed date(s) | | `dateTimeChanged` | string | No | — | Used to find person record changed less than, greater than, equal to, or between passed date(s) | | `nationalId` | string | No | — | National Id | | `nationalIdCountry` | string | No | — | National Id Country | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "lastName": { "type": "string", "description": "Last Name" }, "emailAddress": { "type": "string", "description": "Email Address" }, "addressState": { "type": "string", "description": "Address State" }, "addressCountry": { "type": "string", "description": "Address Country" }, "cobraIsActive": { "type": "string", "description": "Cobra Is Active" }, "cobraStatus": { "type": "string", "description": "Cobra Status" }, "dateOfCobraEvent": { "type": "string", "description": "Used to find date of COBRA event less than, greater than, equal to, or between passed date(s)" }, "dateTimeCreated": { "type": "string", "description": "Used to find person record created less than, greater than, equal to, or between passed date(s)" }, "dateTimeChanged": { "type": "string", "description": "Used to find person record changed less than, greater than, equal to, or between passed date(s)" }, "nationalId": { "type": "string", "description": "National Id" }, "nationalIdCountry": { "type": "string", "description": "National Id Country" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_person\_details\_employee\_id Get a single person detail record **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------- | | `employeeId` | string | Yes | — | Employee Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" } }, "required": [ "PCID", "employeeId" ] } ``` *** ## ukg-employee-core\_get\_personnel\_v1\_user\_profile\_details Get all user profile details **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `masterCompany` | string | No | — | Master Company | | `userStatus` | string | No | — | User Status | | `userId` | string | No | — | User Id | | `roleId` | string | No | — | Role Id | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "masterCompany": { "type": "string", "description": "Master Company" }, "userStatus": { "type": "string", "description": "User Status" }, "userId": { "type": "string", "description": "User Id" }, "roleId": { "type": "string", "description": "Role Id" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_global\_bank\_get Get all direct deposit details for global employees **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `employeeCountry` | string | No | — | Employee Country | | `payGroup` | string | No | — | Pay Group | | `dateModified` | string | No | — | Used to find global employee's direct deposit modified date less than, greater than, equal to, or between passed date(s) | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "employeeCountry": { "type": "string", "description": "Employee Country" }, "payGroup": { "type": "string", "description": "Pay Group" }, "dateModified": { "type": "string", "description": "Used to find global employee's direct deposit modified date less than, greater than, equal to, or between passed date(s)" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_ids Employee ID Lookup **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------ | | `body` | object\[] | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "body": { "type": "array", "items": { "type": "object", "properties": { "employeeIdentifierType": { "type": "string", "enum": [ "EmailAddress", "EmployeeNumber", "NationalID", "SIN", "PersonID", "SSN", "EmployeeID", "UserIntegrationKey" ], "description": "Employee Identifier Type" }, "employeeIdentifierValue": { "type": "string", "description": "Employee Identifier Value (specific to Employee Identifer Type)" }, "companyIdentifierType": { "type": "string", "enum": [ "Company ID", "Company Code", "Federal ID" ], "description": "Company Identifier Type" }, "companyIdentifierValue": { "type": "string", "description": "Company Identifier Value (specific to Company Identifer Type)" } }, "required": [ "employeeIdentifierType", "employeeIdentifierValue" ] }, "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## ukg-employee-core\_international\_employee\_get Get international employee details for all employees **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------- | | `countryCode` | string | No | — | Country Code | | `effectiveDate` | string | No | — | Effective Date | | `employeeId` | string | No | — | Employee Id | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "countryCode": { "type": "string", "description": "Country Code" }, "effectiveDate": { "type": "string", "description": "Effective Date" }, "employeeId": { "type": "string", "description": "Employee Id" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_job\_history\_detail\_get Get all employee job history details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `isOrgChange` | string | No | — | Is Org Change | | `isJobChange` | string | No | — | Is Job Change | | `isRateChange` | string | No | — | Is Rate Change | | `isPromotion` | string | No | — | Is Promotion | | `systemId` | string | No | — | System Id | | `jobEffectiveDate` | string | No | — | Used to find job history effective date less than, greater than, equal to, or between passed date(s) | | `dateTimeCreated` | string | No | — | Used to find job history created less than, greater than, equal to, or between passed date(s) | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "isOrgChange": { "type": "string", "description": "Is Org Change" }, "isJobChange": { "type": "string", "description": "Is Job Change" }, "isRateChange": { "type": "string", "description": "Is Rate Change" }, "isPromotion": { "type": "string", "description": "Is Promotion" }, "systemId": { "type": "string", "description": "System Id" }, "jobEffectiveDate": { "type": "string", "description": "Used to find job history effective date less than, greater than, equal to, or between passed date(s)" }, "dateTimeCreated": { "type": "string", "description": "Used to find job history created less than, greater than, equal to, or between passed date(s)" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_multi\_phone\_numbers\_get Get employee multiple phone numbers **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------- | | `employeeId` | string | No | — | Employee Id | | `systemId` | string | No | — | System Id | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "employeeId": { "type": "string", "description": "Employee Id" }, "systemId": { "type": "string", "description": "System Id" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_national\_document\_get All employee national document details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------------ | ------- | -------- | ------- | -------------------------------------- | | `contactId` | string | No | — | Contact Id | | `employeeId` | string | No | — | Employee Id | | `nationalDocumentIssuingCountryCode` | string | No | — | National Document Issuing Country Code | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contactId": { "type": "string", "description": "Contact Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "nationalDocumentIssuingCountryCode": { "type": "string", "description": "National Document Issuing Country Code" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_position\_report\_get Get Position Report **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | -------------------------- | | `positionCode` | string | No | — | Position Code | | `reportsToPositionCode` | string | No | — | Reports To Position Code | | `effectiveStartDate` | string | No | — | Effective Start Date | | `effectiveStopDate` | string | No | — | Effective Stop Date | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "positionCode": { "type": "string", "description": "Position Code" }, "reportsToPositionCode": { "type": "string", "description": "Reports To Position Code" }, "effectiveStartDate": { "type": "string", "description": "Effective Start Date" }, "effectiveStopDate": { "type": "string", "description": "Effective Stop Date" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_retrieve\_employee\_employment\_details Retrieve Employee Employment Details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------- | | `companyID` | string | No | — | The unique identifier for the company associated with an employee. | | `employeeID` | string | No | — | The unique identifier for an employee within the organization. | | `primaryJobCode` | string | No | — | A code which refers to the primary job code assigned to the employee. | | `jobTitle` | string | No | — | The official job title of the employee. | | `fullTimeOrPartTimeCode` | string | No | — | A code indicating whether the employee is full-time or part-time. | | `primaryWorkLocationCode` | string | No | — | A code indicating the primary work location. | | `primaryProjectCode` | string | No | — | A code indicating the primary project or assignment. | | `deductionGroupCode` | string | No | — | A code indicating the group of deductions. | | `earningGroupCode` | string | No | — | A code indicating the group of earnings. | | `employeeTypeCode` | string | No | — | A code indicating the type of employee. | | `employeeStatusCode` | string | No | — | A code representing the current status of the employee. | | `employeeNumber` | string | No | — | The employee number or identifier. | | `supervisorId` | string | No | — | The unique identifier of the employee's supervisor. | | `originalHireDate` | string | No | — | he date when the employee was originally hired. | | `lastHireDate` | string | No | — | The most recent hire date (if rehired) | | `dateOfTermination` | string | No | — | The date an employee was terminated. | | `dateOfRetirement` | string | No | — | The date an employee retired. | | `dateTimeCreated` | string | No | — | The date and time an employee record was created. | | `dateTimeChanged` | string | No | — | The date and time an employee record was last changed. | | `dateLastPayDatePaid` | string | No | — | The date of an employee's most recently paid pay date. | | `payGroup` | string | No | — | A code representing the pay group or category. | | `isHomeCompany` | string | No | — | A Boolean indicator of whether or not the current company is the employee's home company. | | `page` | integer | No | — | The page number of a paginated response set. | | `per_Page` | integer | No | — | The number of results contained per page in a paginated response set. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyID": { "type": "string", "description": "The unique identifier for the company associated with an employee." }, "employeeID": { "type": "string", "description": "The unique identifier for an employee within the organization." }, "primaryJobCode": { "type": "string", "description": "A code which refers to the primary job code assigned to the employee." }, "jobTitle": { "type": "string", "description": "The official job title of the employee." }, "fullTimeOrPartTimeCode": { "type": "string", "description": "A code indicating whether the employee is full-time or part-time." }, "primaryWorkLocationCode": { "type": "string", "description": "A code indicating the primary work location." }, "primaryProjectCode": { "type": "string", "description": "A code indicating the primary project or assignment." }, "deductionGroupCode": { "type": "string", "description": "A code indicating the group of deductions." }, "earningGroupCode": { "type": "string", "description": "A code indicating the group of earnings." }, "employeeTypeCode": { "type": "string", "description": "A code indicating the type of employee." }, "employeeStatusCode": { "type": "string", "description": "A code representing the current status of the employee." }, "employeeNumber": { "type": "string", "description": "The employee number or identifier." }, "supervisorId": { "type": "string", "description": "The unique identifier of the employee's supervisor." }, "originalHireDate": { "type": "string", "description": "he date when the employee was originally hired." }, "lastHireDate": { "type": "string", "description": "The most recent hire date (if rehired)" }, "dateOfTermination": { "type": "string", "description": "The date an employee was terminated." }, "dateOfRetirement": { "type": "string", "description": "The date an employee retired." }, "dateTimeCreated": { "type": "string", "description": "The date and time an employee record was created." }, "dateTimeChanged": { "type": "string", "description": "The date and time an employee record was last changed." }, "dateLastPayDatePaid": { "type": "string", "description": "The date of an employee's most recently paid pay date." }, "payGroup": { "type": "string", "description": "A code representing the pay group or category." }, "isHomeCompany": { "type": "string", "description": "A Boolean indicator of whether or not the current company is the employee's home company." }, "page": { "type": "integer", "description": "The page number of a paginated response set." }, "per_Page": { "type": "integer", "description": "The number of results contained per page in a paginated response set." } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_supervisor\_details\_get Get Employee Supervisor Details **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | -------------------------- | | `companyId` | string | No | — | Company Id | | `employeeId` | string | No | — | Employee Id | | `supervisorCompanyId` | string | No | — | Supervisor Company Id | | `supervisorEmployeeId` | string | No | — | Supervisor Employee Id | | `supervisorCompanyCode` | string | No | — | Supervisor Company Code | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" }, "employeeId": { "type": "string", "description": "Employee Id" }, "supervisorCompanyId": { "type": "string", "description": "Supervisor Company Id" }, "supervisorEmployeeId": { "type": "string", "description": "Supervisor Employee Id" }, "supervisorCompanyCode": { "type": "string", "description": "Supervisor Company Code" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ``` *** ## ukg-employee-core\_user\_details\_get\_user\_details Get User Details **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------- | | `userName` | string | No | — | User Name | | `userStatus` | string | No | — | User Status | | `employeeId` | string | No | — | Employee Id | | `page` | integer | No | — | Page number for pagination | | `per_Page` | integer | No | — | Number of results per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userName": { "type": "string", "description": "User Name" }, "userStatus": { "type": "string", "description": "User Status" }, "employeeId": { "type": "string", "description": "Employee Id" }, "page": { "type": "integer", "description": "Page number for pagination" }, "per_Page": { "type": "integer", "description": "Number of results per page" } }, "required": [ "PCID" ] } ```