> ## 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-recruiting-admin
> UKG Pro Recruiting Admin - recruiting reference data, onboarding, talent management, and third-party job boards
**Server path:** `/ukg-recruiting-admin` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| [`ukg-recruiting-admin_archive_or_unarchive_behavior`](#ukg-recruiting-admin_archive_or_unarchive_behavior) | Archive or Unarchive Behavior by ID |
| [`ukg-recruiting-admin_archive_or_unarchive_motivation_by_id`](#ukg-recruiting-admin_archive_or_unarchive_motivation_by_id) | Archive or Unarchive Motivation by ID |
| [`ukg-recruiting-admin_archive_or_unarchive_physical_location_by_id`](#ukg-recruiting-admin_archive_or_unarchive_physical_location_by_id) | Archive or Unarchive Physical Location by ID |
| [`ukg-recruiting-admin_create_applicant_source`](#ukg-recruiting-admin_create_applicant_source) | Create Applicant Source |
| [`ukg-recruiting-admin_create_behavior`](#ukg-recruiting-admin_create_behavior) | Create Behavior |
| [`ukg-recruiting-admin_create_disposition_reason`](#ukg-recruiting-admin_create_disposition_reason) | Create Disposition Reason |
| [`ukg-recruiting-admin_create_motivation`](#ukg-recruiting-admin_create_motivation) | Create Motivation |
| [`ukg-recruiting-admin_create_physical_location`](#ukg-recruiting-admin_create_physical_location) | Create Physical Location |
| [`ukg-recruiting-admin_delete_talent_onboarding_v2_tenants_tenant_identifier_new_hires_id`](#ukg-recruiting-admin_delete_talent_onboarding_v2_tenants_tenant_identifier_new_hires_id) | Delete a New Hire |
| [`ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_canceled`](#ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_canceled) | Search Canceled New Hires |
| [`ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_completed`](#ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_completed) | Search Completed New Hires |
| [`ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_id`](#ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_id) | Get a New Hire |
| [`ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_in_progress`](#ukg-recruiting-admin_get_talent_onboarding_v2_tenants_tenant_identifier_new_hires_in_progress) | Search In-Progress New Hires |
| [`ukg-recruiting-admin_get_talent_recruiting_v2_third_party_job_board_integrations_integration_id_postings`](#ukg-recruiting-admin_get_talent_recruiting_v2_third_party_job_board_integrations_integration_id_postings) | Get job postings |
| [`ukg-recruiting-admin_post_signin_oauth2_t_tenant_name_access_token`](#ukg-recruiting-admin_post_signin_oauth2_t_tenant_name_access_token) | Obtain New oAuth Token |
| [`ukg-recruiting-admin_post_talent_onboarding_v2_tenants_tenant_identifier_new_hires`](#ukg-recruiting-admin_post_talent_onboarding_v2_tenants_tenant_identifier_new_hires) | Create a New Hire |
| [`ukg-recruiting-admin_retrieve_all_applicant_sources`](#ukg-recruiting-admin_retrieve_all_applicant_sources) | Retrieve All Applicant Sources |
| [`ukg-recruiting-admin_retrieve_all_behaviors`](#ukg-recruiting-admin_retrieve_all_behaviors) | Retrieve All Behaviors |
| [`ukg-recruiting-admin_retrieve_all_disposition_reasons`](#ukg-recruiting-admin_retrieve_all_disposition_reasons) | Retrieve All Disposition Reasons |
| [`ukg-recruiting-admin_retrieve_all_fields_of_study`](#ukg-recruiting-admin_retrieve_all_fields_of_study) | Retrieve All Fields of Study |
| [`ukg-recruiting-admin_retrieve_all_job_boards`](#ukg-recruiting-admin_retrieve_all_job_boards) | Retrieve All Job Boards |
| [`ukg-recruiting-admin_retrieve_all_legal_entities`](#ukg-recruiting-admin_retrieve_all_legal_entities) | Retrieve All Legal Entities |
| [`ukg-recruiting-admin_retrieve_all_motivations`](#ukg-recruiting-admin_retrieve_all_motivations) | Retrieve All Motivations |
| [`ukg-recruiting-admin_retrieve_all_prefixes`](#ukg-recruiting-admin_retrieve_all_prefixes) | Retrieve All Prefixes |
| [`ukg-recruiting-admin_retrieve_all_proficiency_levels`](#ukg-recruiting-admin_retrieve_all_proficiency_levels) | Retrieve All Proficiency Levels |
| [`ukg-recruiting-admin_retrieve_all_recruiting_processes`](#ukg-recruiting-admin_retrieve_all_recruiting_processes) | Retrieve All Recruiting Processes |
| [`ukg-recruiting-admin_retrieve_all_suffixes`](#ukg-recruiting-admin_retrieve_all_suffixes) | Retrieve All Suffixes |
| [`ukg-recruiting-admin_retrieve_all_tax_locations`](#ukg-recruiting-admin_retrieve_all_tax_locations) | Retrieve All Tax Locations |
| [`ukg-recruiting-admin_retrieve_applicant_source_by_id`](#ukg-recruiting-admin_retrieve_applicant_source_by_id) | Retrieve Applicant Source by ID |
| [`ukg-recruiting-admin_retrieve_application_disposition_events_by_third_party_job_site_integration_id`](#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 |
| [`ukg-recruiting-admin_retrieve_behavior_by_id`](#ukg-recruiting-admin_retrieve_behavior_by_id) | Retrieve Behavior by ID |
| [`ukg-recruiting-admin_retrieve_disposition_reason_by_id`](#ukg-recruiting-admin_retrieve_disposition_reason_by_id) | Retrieve Disposition Reason by ID |
| [`ukg-recruiting-admin_retrieve_field_of_study_by_id`](#ukg-recruiting-admin_retrieve_field_of_study_by_id) | Retrieve Field of Study by ID |
| [`ukg-recruiting-admin_retrieve_job_board_by_id`](#ukg-recruiting-admin_retrieve_job_board_by_id) | Retrieve Job Board by ID |
| [`ukg-recruiting-admin_retrieve_legal_entity_by_id`](#ukg-recruiting-admin_retrieve_legal_entity_by_id) | Retrieve Legal Entity by ID |
| [`ukg-recruiting-admin_retrieve_motivation_by_id`](#ukg-recruiting-admin_retrieve_motivation_by_id) | Retrieve Motivation by ID |
| [`ukg-recruiting-admin_retrieve_org_unit_by_id`](#ukg-recruiting-admin_retrieve_org_unit_by_id) | Retrieve Org Unit by ID |
| [`ukg-recruiting-admin_retrieve_org_units`](#ukg-recruiting-admin_retrieve_org_units) | Retrieve Org Units |
| [`ukg-recruiting-admin_retrieve_physical_location_by_id`](#ukg-recruiting-admin_retrieve_physical_location_by_id) | Retrieve Physical Location by ID |
| [`ukg-recruiting-admin_retrieve_physical_locations`](#ukg-recruiting-admin_retrieve_physical_locations) | Retrieve Physical Locations |
| [`ukg-recruiting-admin_retrieve_prefix_by_id`](#ukg-recruiting-admin_retrieve_prefix_by_id) | Retrieve Prefix by ID |
| [`ukg-recruiting-admin_retrieve_proficiency_levels_by_id`](#ukg-recruiting-admin_retrieve_proficiency_levels_by_id) | Retrieve Proficiency Level by ID |
| [`ukg-recruiting-admin_retrieve_recruiting_processes_by_id`](#ukg-recruiting-admin_retrieve_recruiting_processes_by_id) | Retrieve Recruiting Process By ID |
| [`ukg-recruiting-admin_retrieve_suffix_by_id`](#ukg-recruiting-admin_retrieve_suffix_by_id) | Retrieve Suffix By ID |
| [`ukg-recruiting-admin_retrieve_tax_location_by_id`](#ukg-recruiting-admin_retrieve_tax_location_by_id) | Retrieve Tax Location by ID |
| [`ukg-recruiting-admin_retrieve_third_party_job_site_postings_by_integration_id`](#ukg-recruiting-admin_retrieve_third_party_job_site_postings_by_integration_id) | Retrieve Third Party Job Site Postings by Integration ID |
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"behaviorId": {
"type": "string",
"description": "The unique ID of a behavior."
},
"is_Archived": {
"type": "boolean",
"description": "Is Archived"
}
},
"required": [
"PCID",
"tenantalias",
"behaviorId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"motivationId": {
"type": "string",
"description": "The unique ID of a motivation."
},
"is_archived": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a motivation is archived."
}
},
"required": [
"PCID",
"tenantalias",
"motivationId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"physicalLocationId": {
"type": "string",
"description": "The unique ID of a physical location."
},
"is_archived": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a physical location is archived."
}
},
"required": [
"PCID",
"tenantalias",
"physicalLocationId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"name": {
"type": "object",
"description": "The name of an applicant source in all available languages.",
"properties": {
"de_de": {
"type": "string",
"description": "The German rendering of the applicant source name."
},
"en_gb": {
"type": "string",
"description": "The UK English rendering of the applicant source name."
},
"en_us": {
"type": "string",
"description": "The US English rendering of the applicant source name."
},
"es_es": {
"type": "string",
"description": "The Spanish rendering of the applicant source name."
},
"fr_ca": {
"type": "string",
"description": "The French Canadian rendering of the applicant source name."
},
"pt_br": {
"type": "string",
"description": "The Portuguese rendering of the applicant source name."
}
}
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"description": {
"type": "object",
"description": "The description of a behavior in all available languages.",
"properties": {
"de_de": {
"type": "string",
"description": "The German rendering of the description of a behavior."
},
"en_gb": {
"type": "string",
"description": "The UK English rendering of the description of a behavior."
},
"en_us": {
"type": "string",
"description": "The US English rendering of the description of a behavior."
},
"es_es": {
"type": "string",
"description": "The Spanish rendering of the description of a behavior."
},
"fr_ca": {
"type": "string",
"description": "The French Canadian rendering of the description of a behavior."
},
"pt_br": {
"type": "string",
"description": "The Portuguese rendering of the description of a behavior."
},
"zh_cn": {
"type": "string",
"description": "The Mandarin Chinese rendering of the description of a behavior."
}
}
},
"is_archived": {
"type": "boolean",
"description": "A Boolean indicator of whether or not a behavior is archived."
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "A Hypertext reference to a location on the internet."
},
"rel": {
"type": "string",
"description": "The relationship between the linked document and the current document."
}
}
},
"description": "An array of links associated with a behavior."
},
"name": {
"type": "object",
"description": "The name of a behavior in all available languages.",
"properties": {
"de_de": {
"type": "string",
"description": "The German rendering of the name of a behavior."
},
"en_gb": {
"type": "string",
"description": "The UK English rendering of the name of a behavior."
},
"en_us": {
"type": "string",
"description": "The US English rendering of the name of a behavior."
},
"es_es": {
"type": "string",
"description": "The Spanish rendering of the name of a behavior."
},
"fr_ca": {
"type": "string",
"description": "The French Canadian rendering of the name of a behavior."
},
"pt_br": {
"type": "string",
"description": "The Portuguese rendering of the name of a behavior."
},
"zh_cn": {
"type": "string",
"description": "The Mandarin Chinese rendering of the name of a behavior."
}
}
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"name": {
"type": "object",
"description": "The name of a disposition reason in all available languages.",
"properties": {
"en_gb": {
"type": "string",
"description": "The UK English rendering of a disposition reason."
},
"en_us": {
"type": "string",
"description": "The US English rendering of a disposition reason."
}
}
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The tenantalias value"
},
"description": {
"type": "object",
"description": "The description of a motivation in all available languages. The maximum length is 500 characters.",
"properties": {
"en_us": {
"type": "string",
"description": "The US English rendering of a motivation's description."
},
"es_es": {
"type": "string",
"description": "The Spanish rendering of a motivation's description."
},
"fr_ca": {
"type": "string",
"description": "The French Canadian rendering of a motivation's description."
}
}
},
"name": {
"type": "object",
"description": "The name of a motivation in all available languages. The maximum length is 50 characters. The name must be unique.",
"properties": {
"en_us": {
"type": "string",
"description": "The US English rendering of a motivation's name."
},
"es_es": {
"type": "string",
"description": "The Spanish rendering of a motivation's name."
},
"fr_ca": {
"type": "string",
"description": "The French Canadian rendering of a motivation's name."
}
}
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"address": {
"type": "object",
"description": "The address details.",
"properties": {
"city": {
"type": "string",
"description": "The city associated with an address. The city must be less than 50 characters long."
},
"country": {
"type": "object",
"description": "The country associated with an address."
},
"line1": {
"type": "string",
"description": "The address line 1 of a location. Must be less than 100 characters long."
},
"line2": {
"type": "string",
"description": "The address line 2 of a location. Must be less than 25 characters long."
},
"postal_code": {
"type": "string",
"description": "The postal code of a location. The postal code must be between 3 and 50 characters long."
},
"state": {
"type": "object",
"description": "The state associated with a location."
}
}
},
"coordinates": {
"type": "object",
"description": "The coordinates of a location.",
"properties": {
"latitude": {
"type": "number",
"description": "The location's latitude. Latitude values may range between -90 and 90."
},
"longitude": {
"type": "number",
"description": "The location's longitude. Longitude values may range between -180 and 180."
}
}
},
"location_id": {
"type": "object",
"description": "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.",
"properties": {
"en_us": {
"type": "string",
"description": "The US English rendering of a location identifier."
}
}
},
"name": {
"type": "object",
"description": "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.",
"properties": {
"en_us": {
"type": "string",
"description": "The US English rendering of a location's name."
},
"es_es": {
"type": "string",
"description": "The Spanish rendering of a location's name."
}
}
},
"shapes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"coordinates_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude of one point of a shape. Latitude values may range between -90 and 90."
},
"longitude": {
"type": "number",
"description": "The longitude of one point of a shape. Longitude values may range between -180 and 180."
}
}
},
"description": "An array of coordinates."
}
}
},
"description": "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."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantIdentifier": {
"type": "string",
"description": "Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID."
},
"id": {
"type": "string",
"description": "Unique identifier for the New Hire"
}
},
"required": [
"PCID",
"tenantIdentifier",
"id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantIdentifier": {
"type": "string",
"description": "Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID."
},
"page": {
"type": "integer",
"description": "The page number to retrieve."
},
"per_page": {
"type": "integer",
"description": "The number of items to retrieve per page."
},
"start_date_after": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned."
},
"component_company": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned."
},
"organization_level2": {
"type": "string",
"description": "The UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned."
},
"organization_level3": {
"type": "string",
"description": "The UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned."
},
"organization_level4": {
"type": "string",
"description": "The UKG Pro organization level 4 code to filter by. Only New Hires with this organization level 4 will be returned."
}
},
"required": [
"PCID",
"tenantIdentifier"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantIdentifier": {
"type": "string",
"description": "Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID."
},
"page": {
"type": "integer",
"description": "The page number to retrieve."
},
"per_page": {
"type": "integer",
"description": "The number of items to retrieve per page."
},
"start_date_after": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned."
},
"component_company": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned."
},
"organization_level2": {
"type": "string",
"description": "The UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned."
},
"organization_level3": {
"type": "string",
"description": "The UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned."
},
"organization_level4": {
"type": "string",
"description": "The UKG Pro organization level 4 code to filter by. Only New Hires with this organization level 4 will be returned."
}
},
"required": [
"PCID",
"tenantIdentifier",
"start_date_after",
"start_date_before"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantIdentifier": {
"type": "string",
"description": "Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID."
},
"id": {
"type": "string",
"description": "Unique identifier for the New Hire"
}
},
"required": [
"PCID",
"tenantIdentifier",
"id"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantIdentifier": {
"type": "string",
"description": "Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID."
},
"page": {
"type": "integer",
"description": "The page number to retrieve."
},
"per_page": {
"type": "integer",
"description": "The number of items to retrieve per page."
},
"start_date_after": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The UKG Pro job code or Onboarding job identifier to filter by. Only New Hires with this job will be returned."
},
"component_company": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The UKG Pro organization level 1 code to filter by. Only New Hires with this organization level 1 will be returned."
},
"organization_level2": {
"type": "string",
"description": "The UKG Pro organization level 2 code to filter by. Only New Hires with this organization level 2 will be returned."
},
"organization_level3": {
"type": "string",
"description": "The UKG Pro organization level 3 code to filter by. Only New Hires with this organization level 3 will be returned."
},
"organization_level4": {
"type": "string",
"description": "The UKG Pro organization level 4 code to filter by. Only New Hires with this organization level 4 will be returned."
},
"onboarding_status": {
"type": "string",
"description": "The status of the new hire. Only new hires with the specified status will be returned.",
"enum": [
"InitialReview",
"Launched",
"FinalReview",
"PendingUpdates"
]
}
},
"required": [
"PCID",
"tenantIdentifier"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "A unique integration id provided by Ultimate Software to the Partner during the integration registration process."
},
"page": {
"type": "number",
"description": "Pagination page number"
},
"per_page": {
"type": "number",
"description": "Pagination amount of records per page to display"
},
"Accept": {
"type": "string",
"description": "What content type will the client accept. Valid content types are: - application/json - application/xml - application/vnd.ultimatesoftware+json - application/vnd.ultimatesoftware+xml"
}
},
"required": [
"PCID",
"integrationId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenant-alias": {
"type": "string",
"description": "The tenant alias provided to you by UKG Pro."
},
"Content-Type": {
"type": "string",
"description": "You should enter \"application/x-www-form-urlencoded\"."
},
"client_id": {
"type": "string",
"description": "The client ID provided to you by UKG Pro Identity."
},
"client_secret": {
"type": "string",
"description": "The client secret provided to you by UKG Pro Identity."
},
"grant_type": {
"type": "string",
"description": "You should enter \"client_credentials\"."
},
"scope": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"tenant-alias",
"Content-Type",
"client_id",
"client_secret",
"grant_type",
"scope"
]
}
```
***
## 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 | null | 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 | null | No | — | Orientation date of the new hire |
| `pastStartDateReason` | string | null | 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 | null | No | — | Start date of the new hire |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantIdentifier": {
"type": "string",
"description": "Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID."
},
"compensation": {
"type": "object",
"description": "Compensation information for the new hire",
"properties": {
"isFullTime": {
"type": "boolean",
"description": "Whether the new hire is full time"
},
"isSalaried": {
"type": "boolean",
"description": "Whether the new hire is salaried"
},
"workHours": {
"type": "number",
"description": "Work hours of the new hire"
},
"weeklyHours": {
"type": "number",
"description": "Weekly hours of the new hire. Only applicable for hires not in US/Canadian companies"
},
"currencyCode": {
"type": "string",
"description": "ISO currency code of the new hire"
},
"payRate": {
"type": "number",
"description": "Pay rate of the new hire"
},
"ratePer": {
"type": "string",
"description": "Pay period of the new hire. Accepts \"H\" (Hour), \"W\" (Week), \"P\" (Period), \"Y\" (Year)"
}
}
},
"contactInformation": {
"type": "object",
"description": "Contact information for the new hire",
"properties": {
"name": {
"type": "object",
"description": "Name of the new hire"
},
"emailAddress": {
"type": "string",
"description": "Email address of the new hire"
},
"primaryPhone": {
"type": "string",
"description": "Primary phone number of the new hire. maxLength: 50 for hires not in US/Canadian address country. If hire's address country is US/Canada, a valid phone format is expected"
},
"secondaryPhone": {
"type": "string",
"description": "Secondary phone number of the new hire. maxLength: 50 for hires not in US/Canadian address country. If hire's address country is US/Canada, a valid phone format is expected"
},
"address": {
"type": "object",
"description": "Address of the new hire"
}
},
"required": [
"emailAddress"
]
},
"hireDate": {
"type": [
"string",
"null"
],
"description": "Hire date of the new hire"
},
"job": {
"type": "object",
"description": "Job information for the new hire",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the job"
},
"code": {
"type": "string",
"description": "UKG Pro job code"
},
"requisitionId": {
"type": "string",
"description": "RequisitionId of the job"
},
"componentCompany": {
"type": "object",
"description": "Component company of the job"
},
"workLocation": {
"type": "object",
"description": "Work location of the job"
},
"supervisor": {
"type": "object",
"description": "Supervisor of the job"
},
"employeeType": {
"type": "object",
"description": "Employee type for the job"
},
"selectedFLSAStatus": {
"type": "integer",
"description": "Selected FLSA status for the job. Accepted values are \"0\" (Not Specified), \"1\" (Exempt), or \"2\" (NonExempt)",
"enum": [
0,
1,
2
]
}
}
},
"mentor": {
"type": "object",
"description": "Mentor for the new hire",
"properties": {
"id": {
"type": "string",
"description": "Onboarding employee id"
},
"code": {
"type": "string",
"description": "Person Id from UKG Pro"
},
"description": {
"type": "string",
"description": "Brief description of mentor"
}
}
},
"onboardingOwnerId": {
"type": "string",
"description": "External user identifier of the onboarding owner"
},
"organizationLevels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier of the organization level"
},
"level": {
"type": "integer",
"enum": [
1,
2,
3,
4
],
"description": "Level of the organization level"
},
"code": {
"type": "string",
"description": "Code of the organization level"
}
}
},
"description": "Organization Levels"
},
"orientationDate": {
"type": [
"string",
"null"
],
"description": "Orientation date of the new hire"
},
"pastStartDateReason": {
"type": [
"string",
"null"
],
"description": "Reason why the new hire start date is 4 or more business days in the past"
},
"personalMessage": {
"type": "string",
"description": "Personal message for the new hire"
},
"referenceId": {
"type": "string",
"description": "Customer-provided identifier to track the new hire against their own system"
},
"startDate": {
"type": [
"string",
"null"
],
"description": "Start date of the new hire"
}
},
"required": [
"PCID",
"tenantIdentifier"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The tenantalias value"
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
},
"type": {
"type": "string",
"description": "The type of tax location to return. Results are currently filterable by Tax or Physical."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"applicantSourceId": {
"type": "string",
"description": "The unique ID of an applicant source."
}
},
"required": [
"PCID",
"tenantalias",
"applicantSourceId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "The unique ID of a registered integration."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"integrationId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"behaviorId": {
"type": "string",
"description": "The unique ID of a behavior."
}
},
"required": [
"PCID",
"tenantalias",
"behaviorId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"dispositionReasonId": {
"type": "string",
"description": "The unique ID of a disposition reason."
}
},
"required": [
"PCID",
"tenantalias",
"dispositionReasonId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"fieldOfStudyID": {
"type": "string",
"description": "The unique ID of a field of study."
}
},
"required": [
"PCID",
"tenantalias",
"fieldOfStudyID"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"jobBoardID": {
"type": "string",
"description": "The unique ID of a job board."
}
},
"required": [
"PCID",
"tenantalias",
"jobBoardID"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"legalEntityId": {
"type": "string",
"description": "The unique ID of a legal entity."
}
},
"required": [
"PCID",
"tenantalias",
"legalEntityId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"motivationId": {
"type": "string",
"description": "The unique ID of a motivation."
}
},
"required": [
"PCID",
"tenantalias",
"motivationId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"orgUnitId": {
"type": "string",
"description": "The unique ID of an org unit."
}
},
"required": [
"PCID",
"tenantalias",
"orgUnitId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"physicalLocationId": {
"type": "string",
"description": "The unique ID of a physical location."
}
},
"required": [
"PCID",
"tenantalias",
"physicalLocationId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
},
"updated_after": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"tenantalias"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"prefixID": {
"type": "string",
"description": "The unique ID of a prefix."
}
},
"required": [
"PCID",
"tenantalias",
"prefixID"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"proficiencyLevelId": {
"type": "string",
"description": "Th unique ID of a proficiency level."
}
},
"required": [
"PCID",
"tenantalias",
"proficiencyLevelId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"recruitingProcessID": {
"type": "string",
"description": "The unique ID of a Recruiting process."
}
},
"required": [
"PCID",
"tenantalias",
"recruitingProcessID"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"suffixID": {
"type": "string",
"description": "The unique ID of a suffix."
}
},
"required": [
"PCID",
"tenantalias",
"suffixID"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"locationId": {
"type": "string",
"description": "The unique ID of a tax location."
}
},
"required": [
"PCID",
"tenantalias",
"locationId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"integrationId": {
"type": "string",
"description": "The unique ID of a registered integration."
},
"page": {
"type": "string",
"description": "The page of records to return."
},
"per_page": {
"type": "string",
"description": "The number of resources returned per page. If no pagination parameters are specified, the default maximum is applied."
}
},
"required": [
"PCID",
"integrationId"
]
}
```