/ukg-recruiting-admin | Type: Application | PCID required: Yes
Tools
ukg-recruiting-admin_archive_or_unarchive_behavior
Archive or Unarchive Behavior by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
behaviorId | string | Yes | — | The unique ID of a behavior. |
is_Archived | boolean | No | — | Is Archived |
ukg-recruiting-admin_archive_or_unarchive_motivation_by_id
Archive or Unarchive Motivation by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
motivationId | string | Yes | — | The unique ID of a motivation. |
is_archived | boolean | No | — | A Boolean indicator of whether or not a motivation is archived. |
ukg-recruiting-admin_archive_or_unarchive_physical_location_by_id
Archive or Unarchive Physical Location by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
physicalLocationId | string | Yes | — | The unique ID of a physical location. |
is_archived | boolean | No | — | A Boolean indicator of whether or not a physical location is archived. |
ukg-recruiting-admin_create_applicant_source
Create Applicant Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
name | object | No | — | The name of an applicant source in all available languages. |
ukg-recruiting-admin_create_behavior
Create Behavior Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
description | object | No | — | The description of a behavior in all available languages. |
is_archived | boolean | No | — | A Boolean indicator of whether or not a behavior is archived. |
links | object[] | No | — | An array of links associated with a behavior. |
name | object | No | — | The name of a behavior in all available languages. |
ukg-recruiting-admin_create_disposition_reason
Create Disposition Reason Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
name | object | No | — | The name of a disposition reason in all available languages. |
ukg-recruiting-admin_create_motivation
Create Motivation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The tenantalias value |
description | object | No | — | The description of a motivation in all available languages. The maximum length is 500 characters. |
name | object | No | — | The name of a motivation in all available languages. The maximum length is 50 characters. The name must be unique. |
ukg-recruiting-admin_create_physical_location
Create Physical Location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
address | object | No | — | The address details. |
coordinates | object | No | — | The coordinates of a location. |
location_id | object | No | — | A human-readable location identifier in all available languages. The location ID must be defined with tenant default locale and must be between 1 and 50 characters. |
name | object | No | — | The name of a location in all available languages. The name must be defined with tenant default locale and must be between 1 and 50 characters long. |
shapes | object[] | No | — | An array of shapes. Shapes must contain a coordinates property with valid latitude/longitude pair. At least 3 pairs must be included if providing a shape. |
ukg-recruiting-admin_delete_talent_onboarding_v2_tenants_tenant_identifier_new_hires_id
Delete a New Hire Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantIdentifier | string | Yes | — | Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID. |
id | string | Yes | — | Unique identifier for the New Hire |
ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_canceled
Search Canceled New Hires Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantIdentifier | string | Yes | — | Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID. |
page | integer | No | — | The page number to retrieve. |
per_page | integer | No | — | The number of items to retrieve per page. |
start_date_after | string | No | — | The start date after which to retrieve new hires. Only new hires with a start date set and occurring after this time will be returned. |
start_date_before | string | No | — | The start date before which to retrieve new hires. Only new hires with a start date set and occurring before this time will be returned. |
job | string | No | — | The UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned. |
component_company | string | No | — | The UKG Pro component company code or Onboarding component company identifier to filter by. Only New Hires with this component company will be returned. |
work_location | string | No | — | The UKG Pro work location code or Onboarding work location identifier to filter by. Only New Hires with this work location will be returned. |
onboarding_owner | string | No | — | The UKG Pro Person identifier or Onboarding employee identifier to filter by. Only New Hires with this person as the Onboarding Owner will be returned. |
organization_level1 | string | No | — | The UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned. |
organization_level2 | string | No | — | The UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned. |
organization_level3 | string | No | — | The UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned. |
organization_level4 | string | No | — | The UKG Pro organization level 4 code to filter by. Only New Hires with this organization level 4 will be returned. |
ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_completed
Search Completed New Hires Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantIdentifier | string | Yes | — | Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID. |
page | integer | No | — | The page number to retrieve. |
per_page | integer | No | — | The number of items to retrieve per page. |
start_date_after | string | Yes | — | The start date after which to retrieve new hires. Only new hires with a start date set and occurring after this time will be returned. Must combine with the “start_date_before” value to create a timespan of 12 months or less. |
start_date_before | string | Yes | — | The start date before which to retrieve new hires. Only new hires with a start date set and occurring before this time will be returned. Must combine with the “start_date_after” value to create a timespan of 12 months or less. |
job | string | No | — | The UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned. |
component_company | string | No | — | The UKG Pro component company code or Onboarding component company identifier to filter by. Only New Hires with this component company will be returned. |
work_location | string | No | — | The UKG Pro work location code or Onboarding work location identifier to filter by. Only New Hires with this work location will be returned. |
onboarding_owner | string | No | — | The UKG Pro Person identifier or Onboarding employee identifier to filter by. Only New Hires with this person as the Onboarding Owner will be returned. |
organization_level1 | string | No | — | The UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned. |
organization_level2 | string | No | — | The UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned. |
organization_level3 | string | No | — | The UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned. |
organization_level4 | string | No | — | The UKG Pro organization level 4 code to filter by. Only New Hires with this organization level 4 will be returned. |
ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_id
Get a New Hire Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantIdentifier | string | Yes | — | Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID. |
id | string | Yes | — | Unique identifier for the New Hire |
ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_in_progress
Search In-Progress New Hires Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantIdentifier | string | Yes | — | Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID. |
page | integer | No | — | The page number to retrieve. |
per_page | integer | No | — | The number of items to retrieve per page. |
start_date_after | string | No | — | The start date after which to retrieve new hires. Only new hires with a start date set and occurring after this time will be returned. |
start_date_before | string | No | — | The start date before which to retrieve new hires. Only new hires with a start date set and occurring before this time will be returned. |
job | string | No | — | The UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned. |
component_company | string | No | — | The UKG Pro component company code or Onboarding component company identifier to filter by. Only New Hires with this component company will be returned. |
work_location | string | No | — | The UKG Pro work location code or Onboarding work location identifier to filter by. Only New Hires with this work location will be returned. |
onboarding_owner | string | No | — | The UKG Pro Person identifier or Onboarding employee identifier to filter by. Only New Hires with this person as the Onboarding Owner will be returned. |
organization_level1 | string | No | — | The UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned. |
organization_level2 | string | No | — | The UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned. |
organization_level3 | string | No | — | The UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned. |
organization_level4 | string | No | — | The UKG Pro organization level 4 code to filter by. Only New Hires with this organization level 4 will be returned. |
onboarding_status | string | No | — | The status of the new hire. Only new hires with the specified status will be returned. |
ukg-recruiting-admin_get_talent_recruiting_v2_third_party_job_board_integrations_integration_id_postings
Get job postings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
integrationId | string | Yes | — | A unique integration id provided by Ultimate Software to the Partner during the integration registration process. |
page | number | No | — | Pagination page number |
per_page | number | No | — | Pagination amount of records per page to display |
Accept | string | No | — | What content type will the client accept. Valid content types are: - application/json - application/xml - application/vnd.ultimatesoftware+json - application/vnd.ultimatesoftware+xml |
ukg-recruiting-admin_post_signin_oauth2_t_tenant_name_access_token
Obtain New oAuth Token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenant-alias | string | Yes | — | The tenant alias provided to you by UKG Pro. |
Content-Type | string | Yes | — | You should enter “application/x-www-form-urlencoded”. |
client_id | string | Yes | — | The client ID provided to you by UKG Pro Identity. |
client_secret | string | Yes | — | The client secret provided to you by UKG Pro Identity. |
grant_type | string | Yes | — | You should enter “client_credentials”. |
scope | string | Yes | — | The scope associated with the generated token. Include all of the required scopes needed to access the API operations that will be called using the generated token. |
ukg-recruiting-admin_post_talent_onboarding_v2_tenants_tenant_identifier_new_hires
Create a New Hire Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantIdentifier | string | Yes | — | Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID. |
compensation | object | No | — | Compensation information for the new hire |
contactInformation | object | No | — | Contact information for the new hire |
hireDate | string | No | — | Hire date of the new hire |
job | object | No | — | Job information for the new hire |
mentor | object | No | — | Mentor for the new hire |
onboardingOwnerId | string | No | — | External user identifier of the onboarding owner |
organizationLevels | object[] | No | — | Organization Levels |
orientationDate | string | No | — | Orientation date of the new hire |
pastStartDateReason | string | No | — | Reason why the new hire start date is 4 or more business days in the past |
personalMessage | string | No | — | Personal message for the new hire |
referenceId | string | No | — | Customer-provided identifier to track the new hire against their own system |
startDate | string | No | — | Start date of the new hire |
ukg-recruiting-admin_retrieve_all_applicant_sources
Retrieve All Applicant Sources Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_behaviors
Retrieve All Behaviors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_disposition_reasons
Retrieve All Disposition Reasons Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_fields_of_study
Retrieve All Fields of Study Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_job_boards
Retrieve All Job Boards Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_legal_entities
Retrieve All Legal Entities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
ukg-recruiting-admin_retrieve_all_motivations
Retrieve All Motivations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The tenantalias value |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_prefixes
Retrieve All Prefixes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_proficiency_levels
Retrieve All Proficiency Levels Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_recruiting_processes
Retrieve All Recruiting Processes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_suffixes
Retrieve All Suffixes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_all_tax_locations
Retrieve All Tax Locations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
type | string | No | — | The type of tax location to return. Results are currently filterable by Tax or Physical. |
ukg-recruiting-admin_retrieve_applicant_source_by_id
Retrieve Applicant Source by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
applicantSourceId | string | Yes | — | The unique ID of an applicant source. |
ukg-recruiting-admin_retrieve_application_disposition_events_by_third_party_job_site_integration_id
Retrieve Application Disposition Events by Third Party Job Site Integration ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
integrationId | string | Yes | — | The unique ID of a registered integration. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
ukg-recruiting-admin_retrieve_behavior_by_id
Retrieve Behavior by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
behaviorId | string | Yes | — | The unique ID of a behavior. |
ukg-recruiting-admin_retrieve_disposition_reason_by_id
Retrieve Disposition Reason by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
dispositionReasonId | string | Yes | — | The unique ID of a disposition reason. |
ukg-recruiting-admin_retrieve_field_of_study_by_id
Retrieve Field of Study by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
fieldOfStudyID | string | Yes | — | The unique ID of a field of study. |
ukg-recruiting-admin_retrieve_job_board_by_id
Retrieve Job Board by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
jobBoardID | string | Yes | — | The unique ID of a job board. |
ukg-recruiting-admin_retrieve_legal_entity_by_id
Retrieve Legal Entity by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
legalEntityId | string | Yes | — | The unique ID of a legal entity. |
ukg-recruiting-admin_retrieve_motivation_by_id
Retrieve Motivation by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
motivationId | string | Yes | — | The unique ID of a motivation. |
ukg-recruiting-admin_retrieve_org_unit_by_id
Retrieve Org Unit by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
orgUnitId | string | Yes | — | The unique ID of an org unit. |
ukg-recruiting-admin_retrieve_org_units
Retrieve Org Units Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
ukg-recruiting-admin_retrieve_physical_location_by_id
Retrieve Physical Location by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
physicalLocationId | string | Yes | — | The unique ID of a physical location. |
ukg-recruiting-admin_retrieve_physical_locations
Retrieve Physical Locations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |
updated_after | string | No | — | The date and time on or after which the operation returns applications. Pass a UTC value in order to get accurate results as Recruiting datetime values are in UTC. For example: 2016-12-21T18:44:03.356Z. No quoted values. The system ignores this parameter if the value is not a properly formatted DateTime. Milliseconds are applied to the filter. |
updated_before | string | No | — | The date and time on or before which the operation returns applications. Pass a UTC value in order to get accurate results as Recruiting datetime values are in UTC. For example: 2016-12-21T18:44:03.356Z. No quoted values. The system ignores this parameter if the value is not a properly formatted DateTime. Milliseconds are applied to the filter. |
ukg-recruiting-admin_retrieve_prefix_by_id
Retrieve Prefix by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
prefixID | string | Yes | — | The unique ID of a prefix. |
ukg-recruiting-admin_retrieve_proficiency_levels_by_id
Retrieve Proficiency Level by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
proficiencyLevelId | string | Yes | — | Th unique ID of a proficiency level. |
ukg-recruiting-admin_retrieve_recruiting_processes_by_id
Retrieve Recruiting Process By ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
recruitingProcessID | string | Yes | — | The unique ID of a Recruiting process. |
ukg-recruiting-admin_retrieve_suffix_by_id
Retrieve Suffix By ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
suffixID | string | Yes | — | The unique ID of a suffix. |
ukg-recruiting-admin_retrieve_tax_location_by_id
Retrieve Tax Location by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
locationId | string | Yes | — | The unique ID of a tax location. |
ukg-recruiting-admin_retrieve_third_party_job_site_postings_by_integration_id
Retrieve Third Party Job Site Postings by Integration ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
integrationId | string | Yes | — | The unique ID of a registered integration. |
page | string | No | — | The page of records to return. |
per_page | string | No | — | The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied. |

