Skip to main content
Server path: /ukg-recruiting-admin | Type: Application | PCID required: Yes

Tools

ToolDescription
ukg-recruiting-admin_archive_or_unarchive_behaviorArchive or Unarchive Behavior by ID
ukg-recruiting-admin_archive_or_unarchive_motivation_by_idArchive or Unarchive Motivation by ID
ukg-recruiting-admin_archive_or_unarchive_physical_location_by_idArchive or Unarchive Physical Location by ID
ukg-recruiting-admin_create_applicant_sourceCreate Applicant Source
ukg-recruiting-admin_create_behaviorCreate Behavior
ukg-recruiting-admin_create_disposition_reasonCreate Disposition Reason
ukg-recruiting-admin_create_motivationCreate Motivation
ukg-recruiting-admin_create_physical_locationCreate Physical Location
ukg-recruiting-admin_delete_talent_onboarding_v2_tenants_tenant_identifier_new_hires_idDelete a New Hire
ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_canceledSearch Canceled New Hires
ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_completedSearch Completed New Hires
ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_idGet a New Hire
ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_in_progressSearch In-Progress New Hires
ukg-recruiting-admin_get_talent_recruiting_v2_third_party_job_board_integrations_integration_id_postingsGet job postings
ukg-recruiting-admin_post_signin_oauth2_t_tenant_name_access_tokenObtain New oAuth Token
ukg-recruiting-admin_post_talent_onboarding_v2_tenants_tenant_identifier_new_hiresCreate a New Hire
ukg-recruiting-admin_retrieve_all_applicant_sourcesRetrieve All Applicant Sources
ukg-recruiting-admin_retrieve_all_behaviorsRetrieve All Behaviors
ukg-recruiting-admin_retrieve_all_disposition_reasonsRetrieve All Disposition Reasons
ukg-recruiting-admin_retrieve_all_fields_of_studyRetrieve All Fields of Study
ukg-recruiting-admin_retrieve_all_job_boardsRetrieve All Job Boards
ukg-recruiting-admin_retrieve_all_legal_entitiesRetrieve All Legal Entities
ukg-recruiting-admin_retrieve_all_motivationsRetrieve All Motivations
ukg-recruiting-admin_retrieve_all_prefixesRetrieve All Prefixes
ukg-recruiting-admin_retrieve_all_proficiency_levelsRetrieve All Proficiency Levels
ukg-recruiting-admin_retrieve_all_recruiting_processesRetrieve All Recruiting Processes
ukg-recruiting-admin_retrieve_all_suffixesRetrieve All Suffixes
ukg-recruiting-admin_retrieve_all_tax_locationsRetrieve All Tax Locations
ukg-recruiting-admin_retrieve_applicant_source_by_idRetrieve Applicant Source by ID
ukg-recruiting-admin_retrieve_application_disposition_events_by_third_party_job_site_integration_idRetrieve Application Disposition Events by Third Party Job Site Integration ID
ukg-recruiting-admin_retrieve_behavior_by_idRetrieve Behavior by ID
ukg-recruiting-admin_retrieve_disposition_reason_by_idRetrieve Disposition Reason by ID
ukg-recruiting-admin_retrieve_field_of_study_by_idRetrieve Field of Study by ID
ukg-recruiting-admin_retrieve_job_board_by_idRetrieve Job Board by ID
ukg-recruiting-admin_retrieve_legal_entity_by_idRetrieve Legal Entity by ID
ukg-recruiting-admin_retrieve_motivation_by_idRetrieve Motivation by ID
ukg-recruiting-admin_retrieve_org_unit_by_idRetrieve Org Unit by ID
ukg-recruiting-admin_retrieve_org_unitsRetrieve Org Units
ukg-recruiting-admin_retrieve_physical_location_by_idRetrieve Physical Location by ID
ukg-recruiting-admin_retrieve_physical_locationsRetrieve Physical Locations
ukg-recruiting-admin_retrieve_prefix_by_idRetrieve Prefix by ID
ukg-recruiting-admin_retrieve_proficiency_levels_by_idRetrieve Proficiency Level by ID
ukg-recruiting-admin_retrieve_recruiting_processes_by_idRetrieve Recruiting Process By ID
ukg-recruiting-admin_retrieve_suffix_by_idRetrieve Suffix By ID
ukg-recruiting-admin_retrieve_tax_location_by_idRetrieve Tax Location by ID
ukg-recruiting-admin_retrieve_third_party_job_site_postings_by_integration_idRetrieve Third Party Job Site Postings by Integration ID

ukg-recruiting-admin_archive_or_unarchive_behavior

Archive or Unarchive Behavior by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
behaviorIdstringYesThe unique ID of a behavior.
is_ArchivedbooleanNoIs Archived

ukg-recruiting-admin_archive_or_unarchive_motivation_by_id

Archive or Unarchive Motivation by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
motivationIdstringYesThe unique ID of a motivation.
is_archivedbooleanNoA 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
physicalLocationIdstringYesThe unique ID of a physical location.
is_archivedbooleanNoA Boolean indicator of whether or not a physical location is archived.

ukg-recruiting-admin_create_applicant_source

Create Applicant Source Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
nameobjectNoThe name of an applicant source in all available languages.

ukg-recruiting-admin_create_behavior

Create Behavior Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
descriptionobjectNoThe description of a behavior in all available languages.
is_archivedbooleanNoA Boolean indicator of whether or not a behavior is archived.
linksobject[]NoAn array of links associated with a behavior.
nameobjectNoThe name of a behavior in all available languages.

ukg-recruiting-admin_create_disposition_reason

Create Disposition Reason Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
nameobjectNoThe name of a disposition reason in all available languages.

ukg-recruiting-admin_create_motivation

Create Motivation Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe tenantalias value
descriptionobjectNoThe description of a motivation in all available languages. The maximum length is 500 characters.
nameobjectNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
addressobjectNoThe address details.
coordinatesobjectNoThe coordinates of a location.
location_idobjectNoA 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.
nameobjectNoThe 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.
shapesobject[]NoAn 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:
ParameterTypeRequiredDefaultDescription
tenantIdentifierstringYesUnique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID.
idstringYesUnique identifier for the New Hire

ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_canceled

Search Canceled New Hires Parameters:
ParameterTypeRequiredDefaultDescription
tenantIdentifierstringYesUnique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID.
pageintegerNoThe page number to retrieve.
per_pageintegerNoThe number of items to retrieve per page.
start_date_afterstringNoThe 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_beforestringNoThe start date before which to retrieve new hires. Only new hires with a start date set and occurring before this time will be returned.
jobstringNoThe UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned.
component_companystringNoThe UKG Pro component company code or Onboarding component company identifier to filter by. Only New Hires with this component company will be returned.
work_locationstringNoThe UKG Pro work location code or Onboarding work location identifier to filter by. Only New Hires with this work location will be returned.
onboarding_ownerstringNoThe 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_level1stringNoThe UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned.
organization_level2stringNoThe UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned.
organization_level3stringNoThe UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned.
organization_level4stringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantIdentifierstringYesUnique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID.
pageintegerNoThe page number to retrieve.
per_pageintegerNoThe number of items to retrieve per page.
start_date_afterstringYesThe 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_beforestringYesThe 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.
jobstringNoThe UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned.
component_companystringNoThe UKG Pro component company code or Onboarding component company identifier to filter by. Only New Hires with this component company will be returned.
work_locationstringNoThe UKG Pro work location code or Onboarding work location identifier to filter by. Only New Hires with this work location will be returned.
onboarding_ownerstringNoThe 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_level1stringNoThe UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned.
organization_level2stringNoThe UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned.
organization_level3stringNoThe UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned.
organization_level4stringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantIdentifierstringYesUnique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID.
idstringYesUnique 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:
ParameterTypeRequiredDefaultDescription
tenantIdentifierstringYesUnique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID.
pageintegerNoThe page number to retrieve.
per_pageintegerNoThe number of items to retrieve per page.
start_date_afterstringNoThe 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_beforestringNoThe start date before which to retrieve new hires. Only new hires with a start date set and occurring before this time will be returned.
jobstringNoThe UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned.
component_companystringNoThe UKG Pro component company code or Onboarding component company identifier to filter by. Only New Hires with this component company will be returned.
work_locationstringNoThe UKG Pro work location code or Onboarding work location identifier to filter by. Only New Hires with this work location will be returned.
onboarding_ownerstringNoThe 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_level1stringNoThe UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned.
organization_level2stringNoThe UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned.
organization_level3stringNoThe UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned.
organization_level4stringNoThe UKG Pro organization level 4 code to filter by. Only New Hires with this organization level 4 will be returned.
onboarding_statusstringNoThe 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:
ParameterTypeRequiredDefaultDescription
integrationIdstringYesA unique integration id provided by Ultimate Software to the Partner during the integration registration process.
pagenumberNoPagination page number
per_pagenumberNoPagination amount of records per page to display
AcceptstringNoWhat 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:
ParameterTypeRequiredDefaultDescription
tenant-aliasstringYesThe tenant alias provided to you by UKG Pro.
Content-TypestringYesYou should enter “application/x-www-form-urlencoded”.
client_idstringYesThe client ID provided to you by UKG Pro Identity.
client_secretstringYesThe client secret provided to you by UKG Pro Identity.
grant_typestringYesYou should enter “client_credentials”.
scopestringYesThe 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:
ParameterTypeRequiredDefaultDescription
tenantIdentifierstringYesUnique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID.
compensationobjectNoCompensation information for the new hire
contactInformationobjectNoContact information for the new hire
hireDatestringNoHire date of the new hire
jobobjectNoJob information for the new hire
mentorobjectNoMentor for the new hire
onboardingOwnerIdstringNoExternal user identifier of the onboarding owner
organizationLevelsobject[]NoOrganization Levels
orientationDatestringNoOrientation date of the new hire
pastStartDateReasonstringNoReason why the new hire start date is 4 or more business days in the past
personalMessagestringNoPersonal message for the new hire
referenceIdstringNoCustomer-provided identifier to track the new hire against their own system
startDatestringNoStart date of the new hire

ukg-recruiting-admin_retrieve_all_applicant_sources

Retrieve All Applicant Sources Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe number of resources returned per page. If no pagination parameters are specified, the default maximum is applied.

Retrieve All Legal Entities Parameters:
ParameterTypeRequiredDefaultDescription
pagestringNoThe page of records to return.
per_pagestringNoThe number of resources returned per page. If no pagination parameters are specified, the default maximum is applied.
tenantaliasstringYesThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe tenantalias value
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe number of resources returned per page. If no pagination parameters are specified, the default maximum is applied.
typestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
applicantSourceIdstringYesThe 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:
ParameterTypeRequiredDefaultDescription
integrationIdstringYesThe unique ID of a registered integration.
pagestringNoThe page of records to return.
per_pagestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
behaviorIdstringYesThe unique ID of a behavior.

ukg-recruiting-admin_retrieve_disposition_reason_by_id

Retrieve Disposition Reason by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
dispositionReasonIdstringYesThe unique ID of a disposition reason.

ukg-recruiting-admin_retrieve_field_of_study_by_id

Retrieve Field of Study by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
fieldOfStudyIDstringYesThe unique ID of a field of study.

ukg-recruiting-admin_retrieve_job_board_by_id

Retrieve Job Board by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
jobBoardIDstringYesThe unique ID of a job board.

Retrieve Legal Entity by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
legalEntityIdstringYesThe unique ID of a legal entity.

ukg-recruiting-admin_retrieve_motivation_by_id

Retrieve Motivation by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
motivationIdstringYesThe unique ID of a motivation.

ukg-recruiting-admin_retrieve_org_unit_by_id

Retrieve Org Unit by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
orgUnitIdstringYesThe unique ID of an org unit.

ukg-recruiting-admin_retrieve_org_units

Retrieve Org Units Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
physicalLocationIdstringYesThe unique ID of a physical location.

ukg-recruiting-admin_retrieve_physical_locations

Retrieve Physical Locations Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
pagestringNoThe page of records to return.
per_pagestringNoThe number of resources returned per page. If no pagination parameters are specified, the default maximum is applied.
updated_afterstringNoThe 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_beforestringNoThe 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:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
prefixIDstringYesThe unique ID of a prefix.

ukg-recruiting-admin_retrieve_proficiency_levels_by_id

Retrieve Proficiency Level by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
proficiencyLevelIdstringYesTh unique ID of a proficiency level.

ukg-recruiting-admin_retrieve_recruiting_processes_by_id

Retrieve Recruiting Process By ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
recruitingProcessIDstringYesThe unique ID of a Recruiting process.

ukg-recruiting-admin_retrieve_suffix_by_id

Retrieve Suffix By ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
suffixIDstringYesThe unique ID of a suffix.

ukg-recruiting-admin_retrieve_tax_location_by_id

Retrieve Tax Location by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantaliasstringYesThe customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
locationIdstringYesThe 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:
ParameterTypeRequiredDefaultDescription
integrationIdstringYesThe unique ID of a registered integration.
pagestringNoThe page of records to return.
per_pagestringNoThe number of resources returned per page. If no pagination parameters are specified, the default maximum is applied.