ukg-recruiting-pipeline

UKG Pro Recruiting Pipeline - opportunities, applications, offers, and disposition events

Server path: /ukg-recruiting-pipeline | Type: Application | PCID required: Yes

Tools

Tool	Description
ukg-recruiting-pipeline_close_opportunity_by_id	Close Opportunity by ID
ukg-recruiting-pipeline_create_application	Create Application
ukg-recruiting-pipeline_create_comment_by_application_id	Create Comment by Application ID
ukg-recruiting-pipeline_create_offer	Create Offer
ukg-recruiting-pipeline_create_opportunity	Create Opportunity
ukg-recruiting-pipeline_create_opportunity_assessment	Create Opportunity Assessment
ukg-recruiting-pipeline_create_opportunity_screening_question	Create Opportunity Screening Question
ukg-recruiting-pipeline_deactivate_opportunity_screening_questions	Deactivate Opportunity Screening Questions
ukg-recruiting-pipeline_delete_opportunity_assessment_by_id	Delete Opportunity Assessment by ID
ukg-recruiting-pipeline_disposition_application_by_id	Disposition Application by ID
ukg-recruiting-pipeline_initiate_hire_by_application_id	Initiate Hire by Application ID
ukg-recruiting-pipeline_look_up_easy_apply_application_by_candidate_opportunity_and_integration_id	Look Up EasyApply Application by Candidate, Opportunity, and Integration ID
ukg-recruiting-pipeline_publish_opportunity_by_id	Publish Opportunity by ID
ukg-recruiting-pipeline_refresh_opportunity_by_id	Refresh Opportunity by ID
ukg-recruiting-pipeline_retrieve_all_opportunity_assessments	Retrieve All Opportunity Assessments
ukg-recruiting-pipeline_retrieve_application_by_id	Retrieve Application by ID
ukg-recruiting-pipeline_retrieve_application_disposition_events	Retrieve Application Disposition Events
ukg-recruiting-pipeline_retrieve_application_disposition_events_by_application_id	Retrieve Application Disposition Events by Application ID
ukg-recruiting-pipeline_retrieve_applications	Retrieve Applications
ukg-recruiting-pipeline_retrieve_applications_by_candidate_id	Retrieve Applications by Candidate ID
ukg-recruiting-pipeline_retrieve_comments_by_application_id	Retrieve Comments by Application ID
ukg-recruiting-pipeline_retrieve_offer_actions_by_offer_id	Retrieve Offer Actions by Offer ID
ukg-recruiting-pipeline_retrieve_offers	Retrieve Offers
ukg-recruiting-pipeline_retrieve_opportunities	Retrieve Opportunities
ukg-recruiting-pipeline_retrieve_opportunity_assessment_by_id	Retrieve Opportunity Assessment by ID
ukg-recruiting-pipeline_retrieve_opportunity_by_id	Retrieve Opportunity by ID
ukg-recruiting-pipeline_retrieve_opportunity_country_questions	Retrieve Opportunity Country Questions
ukg-recruiting-pipeline_retrieve_opportunity_screening_questions	Retrieve Opportunity Screening Questions
ukg-recruiting-pipeline_retrieve_recruiters_an_opportunity_is_shared_with	Retrieve Recruiters an Opportunity is Shared With
ukg-recruiting-pipeline_share_opportunity_with_recruiter	Share Opportunity With Recruiter
ukg-recruiting-pipeline_submit_offer_for_approval_by_id	Submit Offer for Approval by ID
ukg-recruiting-pipeline_update_opportunity_assessment_by_id	Update Opportunity Assessment by ID
ukg-recruiting-pipeline_update_opportunity_screening_question_by_id	Update Opportunity Screening Question by ID
ukg-recruiting-pipeline_upload_application_document	Upload Application Document

---

ukg-recruiting-pipeline_close_opportunity_by_id

Close Opportunity 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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
closed_by	string	No	—	The unique ID of the person who is closing the opportunity in GUID format.
closed_date	string	No	—	The date and time an opportunity was closed. This value cannot be a future date. If not specified, defaults to UTC now.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "closed_by": {
      "type": "string",
      "description": "The unique ID of the person who is closing the opportunity in GUID format."
    },
    "closed_date": {
      "type": "string",
      "description": "The date and time an opportunity was closed. This value cannot be a future date. If not specified, defaults to UTC now."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId"
  ]
}

---

ukg-recruiting-pipeline_create_application

Create Application

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.
applicant_source	object	No	—	The applicant source model.
applied_date	string	No	—	The date on which the candidate applied or UtcNow if omitted. This date must not be after the current date or the available start date and must not be before the opportunity’s posted date.
availability	object	No	—	The candidate’s schedule availability. For example: Monday: from 8AM to 12PM Tuesday: from 2PM to 6PM Friday: from 9AM to 5PM Certain conditions that the model cannot capture can be specified in the notes. For example: available only during summer available every other Monday.
available_start_date	string	Yes	—	The date that the candidate is available to start. The date must not be before the applied date.
candidate	object	No	—	The candidate model.
country_specific_responses	object[]	No	—	An array of answers to country-specific questions for the opportunity’s given country. Refer to the example for the proper format. Responses are optional for all country questions, but if a response is provided for a specific type of country question, the question type must be valid and the answer must be valid. Responses to disability questions must not be more than 250 characters. Refer to the table associated with this operation to see valid types of country-specific questions and responses.
creator	object	No	—	The creator model.
job_board	object	No	—	The job board model.
job_posting	object	No	—	The job posting model.
opportunity	object	No	—	The opportunity model.
screening_question_responses	object[]	No	—	An array of answers to screening questions indexed with a 0-based index value for each answer. The number of responses must match the number of screening questions. If a response is for a text question, it must not be longer than 4,000 characters. If a response is for a multi-choice question, the value must not be less than 0 and must be less than the total number of questions.

Show inputSchema

{
  "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."
    },
    "applicant_source": {
      "type": "object",
      "description": "The applicant source model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the applicant source that was manually selected by the candidate when applying. Must not be archived. Optional if `job_posting` is supplied."
        }
      }
    },
    "applied_date": {
      "type": "string",
      "description": "The date on which the candidate applied or UtcNow if omitted. This date must not be after the current date or the available start date and must not be before the opportunity's posted date."
    },
    "availability": {
      "type": "object",
      "description": "The candidate's schedule availability. For example: Monday: from 8AM to 12PM Tuesday: from 2PM to 6PM Friday: from 9AM to 5PM  Certain conditions that the model cannot capture can be specified in the notes. For example: available only during summer available every other Monday.",
      "properties": {
        "time_slots": {
          "type": "array",
          "items": {
            "type": "array"
          },
          "description": "An array of available time slots."
        },
        "time_zone": {
          "type": "object",
          "description": "The time zone of the availability time slots."
        },
        "notes": {
          "type": "string",
          "description": "Additional notes regarding availability. Certain conditions that the model cannot capture can be specified in the notes. For example: available only during summer available every other Monday"
        }
      }
    },
    "available_start_date": {
      "type": "string",
      "description": "The date that the candidate is available to start. The date must not be before the applied date."
    },
    "candidate": {
      "type": "object",
      "description": "The candidate model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the candidate who applied to an application."
        }
      },
      "required": [
        "id"
      ]
    },
    "country_specific_responses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "question": {
            "type": "object",
            "description": "The country-specific question model."
          },
          "response": {
            "type": "string",
            "description": "The country-specific response. If the 'responses' property contains values, it will be skipped."
          },
          "responses": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The country-specific question responses."
          }
        }
      },
      "description": "An array of answers to country-specific questions for the opportunity's given country. Refer to the example for the proper format. Responses are optional for all country questions, but if a response is provided for a specific type of country question, the question type must be valid and the answer must be valid. Responses to disability questions must not be more than 250 characters.  Refer to the table associated with this operation to see valid types of country-specific questions and responses."
    },
    "creator": {
      "type": "object",
      "description": "The creator model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the person creating the application."
        }
      }
    },
    "job_board": {
      "type": "object",
      "description": "The job board model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the job board on which the opportunity is listed."
        }
      }
    },
    "job_posting": {
      "type": "object",
      "description": "The job posting model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of a third-party job board posting from which the applicant is applying. If supplied, the job board must be a posting that is for the same opportunity as specified in the opportunity property. Optional if `applicant_source` is supplied."
        }
      }
    },
    "opportunity": {
      "type": "object",
      "description": "The opportunity model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the opportunity to which a candidate is applying. The opportunity must be accessible by the specified candidate and the candidate must not already have an application for the opportunity."
        }
      },
      "required": [
        "id"
      ]
    },
    "screening_question_responses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "question": {
            "type": "object",
            "description": "The screening question model."
          },
          "response": {
            "type": "integer",
            "description": "The applicant's response to the screening question."
          },
          "recruiter_declined_to_answer": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not the applicant declined to answer the screening question."
          }
        }
      },
      "description": "An array of answers to screening questions indexed with a 0-based index value for each answer. The number of responses must match the number of screening questions.  If a response is for a text question, it must not be longer than 4,000 characters. If a response is for a multi-choice question, the value must not be less than 0 and must be less than the total number of questions."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "available_start_date"
  ]
}

---

ukg-recruiting-pipeline_create_comment_by_application_id

Create Comment by Application 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.
applicationId	string	Yes	—	The unique ID of an application.
author	object	No	—	The author model.
comment	string	null	Yes	—	The comment text. Cannot be empty or contain only spaces. Maximum 4000 characters.
created_at	string	No	—	The comment creation time stamp. When not provided it defaults to current UTC time. Cannot be a date occurring in the future or earlier than the applied date.
is_important	boolean	No	—	A Boolean indicator of whether or not a comment is important. Defaults to false.

Show inputSchema

{
  "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."
    },
    "applicationId": {
      "type": "string",
      "description": "The unique ID of an application."
    },
    "author": {
      "type": "object",
      "description": "The author model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the author. Must be an internal candidate."
        }
      },
      "required": [
        "id"
      ]
    },
    "comment": {
      "type": [
        "string",
        "null"
      ],
      "description": "The comment text. Cannot be empty or contain only spaces. Maximum 4000 characters."
    },
    "created_at": {
      "type": "string",
      "description": "The comment creation time stamp. When not provided it defaults to current UTC time.  Cannot be a date occurring in the future or earlier than the applied date."
    },
    "is_important": {
      "type": "boolean",
      "description": "A Boolean indicator of whether or not a comment is important. Defaults to `false`."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "applicationId",
    "comment"
  ]
}

---

ukg-recruiting-pipeline_create_offer

Create Offer

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.
application	object	No	—	The application model.
approval_process_type	string	No	—	The approval process type. Valid values include parallel and sequential.
approvers	object[]	No	—	An array of offer’s approvers.
body	object	No	—	The text body of an offer in all available languages.
brand	object	No	—	The brand details.
created_at	string	No	—	The date and time an offer was created.
creator	object	No	—	The creator model.
hiring_manager	object	No	—	The hiring manager associated with the offer.
recruiter	object	No	—	The recruiter associated with the offer.
template	object	No	—	A template associated with the offer.

Show inputSchema

{
  "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."
    },
    "application": {
      "type": "object",
      "description": "The application model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the application."
        }
      }
    },
    "approval_process_type": {
      "type": "string",
      "description": "The approval process type. Valid values include parallel and sequential.",
      "enum": [
        "parallel",
        "sequential"
      ]
    },
    "approvers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "The approver ID. Must be valid recruiter or hiring manager."
          }
        }
      },
      "description": "An array of offer's approvers."
    },
    "body": {
      "type": "object",
      "description": "The text body of an offer in all available languages.",
      "properties": {
        "en_us": {
          "type": "string",
          "description": "The locale for English (US)."
        }
      }
    },
    "brand": {
      "type": "object",
      "description": "The brand details.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique ID of a brand in GUID format."
        }
      }
    },
    "created_at": {
      "type": "string",
      "description": "The date and time an offer was created."
    },
    "creator": {
      "type": "object",
      "description": "The creator model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the creator of the offer in GUID format."
        }
      },
      "required": [
        "id"
      ]
    },
    "hiring_manager": {
      "type": "object",
      "description": "The hiring manager associated with the offer.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the hiring manager."
        }
      }
    },
    "recruiter": {
      "type": "object",
      "description": "The recruiter associated with the offer.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the recruiter."
        }
      }
    },
    "template": {
      "type": "object",
      "description": "A template associated with the offer.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the template associated with the offer."
        }
      }
    }
  },
  "required": [
    "PCID",
    "tenantalias"
  ]
}

---

ukg-recruiting-pipeline_create_opportunity

Create Opportunity

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.
approver	object	No	—	The approver associated with an opportunity.
behavior_criteria	object[]	No	—	An array of an opportunity’s behavior criteria. All behavior criteria must have a valid behavior ID and the behavior must not be archived.
company	object	No	—	The company associated with an opportunity.
compensation	object	No	—	The compensation details associated with an opportunity.
created_at	string	No	—	The date and time the opportunity was created. Defaults to NOW.
default_locale	object	No	—	The default locale associated with an opportunity.
description	object	No	—	The description of an opportunity in all available languages.
education_criteria	object[]	No	—	An array of an opportunity’s education criteria. The only required field when education is included is degree, and a valid degree ID must be specified. If a major is included, it must be a valid major ID.
employee_type	object	No	—	The employee type associated with an opportunity.
full_time_equivalent	object	No	—	The full time equivalent model, which is an integer representing what is defined as full time.
head_count	object	No	—	The head count associated with an opportunity.
hiring_manager	object	No	—	The hiring manager associated with an opportunity.
hours_per_shift	integer	No	—	The number of hours per shift. Defaults to null.
hours_per_week	integer	No	—	The number of hours per week. Defaults to null.
incumbent	object	No	—	The incumbent who occupied an opportunity’s listed position prior to the opportunity’s candidate.
internal_notes	object	No	—	An opportunity’s internal notes. Maximum of 4,000 characters.
internal_title	object	No	—	The internal title of an opportunity. Optional. Maximum of 75 characters. Uses the value associated with the default locale. If the default locale is not provided, it uses the default tenant locale.
is_budgeted	string	No	—	An opportunity’s budgeting status (yes, no). Defaults to null.
is_continuous_opening	boolean	No	—	A Boolean indicator of whether or not an opportunity is a continous or ‘forever’ opening. Defaults to false. If true, full_time_equivalent and head_count are ignored.
is_featured	boolean	No	—	A Boolean indicator of whether or not an opportunity is featured. Defaults to false.
is_shared_with_everyone	boolean	No	—	A Boolean indicator of whether or not an opportunity is shared with everyone. Defaults to false.
job	object	No	—	The job associated with an opportunity.
job_boards	object[]	No	—	An array of an opportunity’s associated job boards, which must be valid job boards. Not required to publish.
job_family	object	No	—	The job family details associated with an opportunity.
justification_comments	object[]	No	—	An array of an opportunity’s justification comments. Maximum of 10 comments per opportunity. Each comment has a maximum of 500 characters.
license_and_certification_criteria	object[]	No	—	An array containing an opportunity’s license and certification criteria. All license and certification criteria must have a valid license ID.
locations	object[]	No	—	An array of an opportunity’s locations. They must be valid locations. At least one location is required to publish. If the UserDefinedLocations feature toggle is off, each location must be a valid GUID for a record in the Location collection. If the UserDefinedLocations feature toggle is on, each location must be a valid GUID for a record in the PhysicalLocation collection.
motivation_criteria	object[]	No	—	An array of an opportunity’s motivation criteria.
onboarding_owner	object	No	—	The onboarding owner associated with an opportunity.
opening_reason	string	No	—	An opportunity’s opening reason (new-headcount, replacement, over-hire, temporary). Defaults to null.
org_unit_groups	object[]	No	—	An array of an opportunity’s org unit groups. Maximum of 20 org unit groups per opportunity. Each org unit group consists of a set of org units: org unit 1, org unit 2, …org unit N. Currently, the Recruiting system supports only one group of org units, but multiple group support will be added in the future.
priority	string	No	—	An opportunity’s priority (low, medium, high). Defaults to null.
recruiter	object	No	—	The recruiter associated with an opportunity.
recruiting_process	object	No	—	The recruiting process associated with an opportunity.
request_candidate_availability	boolean	No	—	A Boolean indicator of whether or not to request a candidate’s availability. Defaults to false.
skill_criteria	object[]	No	—	An array of an opportunity’s skill criteria. All skill criteria must have a valid skill ID and proficiency level ID.
staffing_plan_impact	string	No	—	An opportunity’s impact to staffing plan notes. Defaults to null. Maximum 500 characters.
supervisor	object	No	—	The supervisor associated with an opportunity.
target_start_date	string	null	No	—	An opportunity’s target start date. Defaults to null.
title	object	No	—	The title of an opportunity in all available languages. Maximum of 75 characters. Required to publish.
travel	object	No	—	The travel model for an opportunity.
work_experience_criteria	object[]	No	—	An array of an opportunity’s work experience criteria. All work experiences must have a translation for the opportunity’s default language code.

Show inputSchema

{
  "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."
    },
    "approver": {
      "type": "object",
      "description": "The approver associated with an opportunity.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of an opportunity's approver, which must be a valid recruiter or hiring manager.  __NOTE:__ The approver must be null if the approvals feature is disabled."
        }
      }
    },
    "behavior_criteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "is_required": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not a behavior criteria is required."
          },
          "behavior": {
            "type": "object",
            "description": "The behavior model."
          }
        }
      },
      "description": "An array of an opportunity's behavior criteria. All behavior criteria must have a valid behavior ID and the behavior must not be archived."
    },
    "company": {
      "type": "object",
      "description": "The company associated with an opportunity.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of an opportunity's company, which must be a valid company. The company's country must match the job's country. Required to publish."
        }
      }
    },
    "compensation": {
      "type": "object",
      "description": "The compensation details associated with an opportunity.",
      "properties": {
        "is_full_time": {
          "type": "boolean",
          "description": "A Boolean indicator of whether or not an opportunity is full-time. Defaults to true."
        },
        "is_salaried": {
          "type": "boolean",
          "description": "A Boolean indicator of whether or not an opportunity is salaried. Defaults to true."
        },
        "pay_rate": {
          "type": "integer",
          "description": "The pay rate of an opportunity. Required to publish, but can be 0."
        },
        "shown": {
          "type": "string",
          "description": "An opportunity's compensation visibility (All, Internal, External, None). Defaults to `None`."
        },
        "currency": {
          "type": "object",
          "description": "The currency details associated with an opportunity."
        }
      }
    },
    "created_at": {
      "type": "string",
      "description": "The date and time the opportunity was created. Defaults to NOW."
    },
    "default_locale": {
      "type": "object",
      "description": "The default locale associated with an opportunity.",
      "properties": {
        "code": {
          "type": "string",
          "description": "An opportunity's default language code. Defaults to the tenant default language code."
        }
      }
    },
    "description": {
      "type": "object",
      "description": "The description of an opportunity in all available languages.",
      "properties": {
        "brief": {
          "type": "object",
          "description": "The brief description of an opportunity in all available languages."
        },
        "detailed": {
          "type": "object",
          "description": "The detailed description of an opportunity in all available languages."
        }
      }
    },
    "education_criteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "is_required": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not an education criteria is required."
          },
          "allow_related": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not to allow related education criteria to meet the requirements of an opportunity."
          },
          "degree": {
            "type": "object",
            "description": "The degree associated with an education criteria."
          },
          "major": {
            "type": "object",
            "description": "The major field of study associated with an education criteria."
          }
        }
      },
      "description": "An array of an opportunity's education criteria. The only required field when education is included is degree, and a valid degree ID must be specified. If a major is included, it must be a valid major ID."
    },
    "employee_type": {
      "type": "object",
      "description": "The employee type associated with an opportunity.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of an opportunity's employee type, which must be one of the currently available employee types. Employee types can be retrieved by calling the [Retrieve all employeeType configurations](ref:retrieve-all-employee-type-configurations) operation."
        }
      }
    },
    "full_time_equivalent": {
      "type": "object",
      "description": "The full time equivalent model, which is an integer representing what is defined as full time.",
      "properties": {
        "budgeted": {
          "type": "integer",
          "description": "The budgeted full time equivalent, which must be a number greater than zero with a maximum of four decimal places. The maximum value is 9,999,999,999.9999 and the default value is `null`."
        }
      }
    },
    "head_count": {
      "type": "object",
      "description": "The head count associated with an opportunity.",
      "properties": {
        "max": {
          "type": "integer",
          "description": "The maximum head count associated with an opportunity, which must be a number greater than zero with a maximum length of 15 characters."
        }
      }
    },
    "hiring_manager": {
      "type": "object",
      "description": "The hiring manager associated with an opportunity.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of an opportunity's hiring manager, which must be a valid hiring manager."
        }
      }
    },
    "hours_per_shift": {
      "type": "integer",
      "description": "The number of hours per shift. Defaults to `null`."
    },
    "hours_per_week": {
      "type": "integer",
      "description": "The number of hours per week. Defaults to `null`."
    },
    "incumbent": {
      "type": "object",
      "description": "The incumbent who occupied an opportunity's listed position prior to the opportunity's candidate.",
      "properties": {
        "first_name": {
          "type": "string",
          "description": "The incumbent's first name. Defaults to `null`. Maximum 100 characters."
        },
        "last_name": {
          "type": "string",
          "description": "The incumbent's last name. Defaults to `null`. Maximum 100 characters."
        },
        "last_day_worked": {
          "type": "string",
          "description": "The incumbent's last day worked. Defaults to `null`."
        }
      }
    },
    "internal_notes": {
      "type": "object",
      "description": "An opportunity's internal notes. Maximum of 4,000 characters.",
      "properties": {
        "en_us": {
          "type": "string",
          "description": "The US English rendering of an opportunity's internal notes."
        }
      }
    },
    "internal_title": {
      "type": "object",
      "description": "The internal title of an opportunity. Optional. Maximum of 75 characters. Uses the value associated with the default locale. If the default locale is not provided, it uses the default tenant locale.",
      "properties": {
        "en_US": {
          "type": "string",
          "description": "The US English rendering of the opportunity's internal title."
        }
      }
    },
    "is_budgeted": {
      "type": "string",
      "description": "An opportunity's budgeting status (yes, no). Defaults to null."
    },
    "is_continuous_opening": {
      "type": "boolean",
      "description": "A Boolean indicator of whether or not an opportunity is a continous or 'forever' opening. Defaults to false. If true, `full_time_equivalent` and `head_count` are ignored."
    },
    "is_featured": {
      "type": "boolean",
      "description": "A Boolean indicator of whether or not an opportunity is featured. Defaults to false."
    },
    "is_shared_with_everyone": {
      "type": "boolean",
      "description": "A Boolean indicator of whether or not an opportunity is shared with everyone. Defaults to false."
    },
    "job": {
      "type": "object",
      "description": "The job associated with an opportunity.",
      "properties": {
        "code": {
          "type": "string",
          "description": "The job code associated with an opportunity."
        }
      },
      "required": [
        "code"
      ]
    },
    "job_boards": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of a job board."
          },
          "is_published_internal": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not a job board is published internally."
          },
          "is_published_external": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not a job board is published externally."
          }
        }
      },
      "description": "An array of an opportunity's associated job boards, which must be valid job boards. Not required to publish."
    },
    "job_family": {
      "type": "object",
      "description": "The job family details associated with an opportunity.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of an opportunity's job family. Required to publish."
        }
      }
    },
    "justification_comments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "comment": {
            "type": "string",
            "description": "The text of a comment. Maximum of 500 characters."
          }
        }
      },
      "description": "An array of an opportunity's justification comments. Maximum of 10 comments per opportunity. Each comment has a maximum of 500 characters."
    },
    "license_and_certification_criteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "is_required": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not a license and certification criteria is required."
          },
          "license": {
            "type": "object",
            "description": "The license model."
          }
        }
      },
      "description": "An array containing an opportunity's license and certification criteria. All license and certification criteria must have a valid license ID."
    },
    "locations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique ID of a location in GUID format."
          }
        }
      },
      "description": "An array of an opportunity's locations. They must be valid locations. At least one location is required to publish.  If the `UserDefinedLocations` feature toggle is off, each location must be a valid GUID for a record in the `Location` collection.  If the `UserDefinedLocations` feature toggle is on, each location must be a valid GUID for a record in the `PhysicalLocation` collection."
    },
    "motivation_criteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "is_required": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not a motivation criteria is required. Defaults to false."
          },
          "motivation": {
            "type": "object",
            "description": "The motivation model."
          }
        }
      },
      "description": "An array of an opportunity's motivation criteria."
    },
    "onboarding_owner": {
      "type": "object",
      "description": "The onboarding owner associated with an opportunity.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of an opportunity's onboarding owner, which must be a valid onboarding owner.  __Note:__ Can also be a hiring manager if tenant has `IncludeHiringManagersInOnboardingOwnerField` enabled.  __Note:__ Must be a valid hiring manager if the `OnboardingOwnerRole` feature is disabled."
        }
      }
    },
    "opening_reason": {
      "type": "string",
      "description": "An opportunity's opening reason (new-headcount, replacement, over-hire, temporary). Defaults to `null`."
    },
    "org_unit_groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "org_units": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The ID of an org level unit in GUID format. Must be active in UKG Pro. A group may contain only one org level unit of each level. For example, only one Region, only one Division, and so on."
                }
              }
            },
            "description": "An array of org units."
          }
        }
      },
      "description": "An array of an opportunity's org unit groups. Maximum of 20 org unit groups per opportunity.  Each org unit group consists of a set of org units: org unit 1, org unit 2, ...org unit N. Currently, the Recruiting system supports only one group of org units, but multiple group support will be added in the future."
    },
    "priority": {
      "type": "string",
      "description": "An opportunity's priority (low, medium, high). Defaults to `null`."
    },
    "recruiter": {
      "type": "object",
      "description": "The recruiter associated with an opportunity.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of an opportunity's recruiter, which must be a valid recruiter or hiring manager. Required to publish.  __Note:__ Can only be a hiring manager if the tenant has `IncludeHiringManagersInRecruiterField` enabled."
        }
      }
    },
    "recruiting_process": {
      "type": "object",
      "description": "The recruiting process associated with an opportunity.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of an opportunity's recruiting process, which must be a valid recruiting process. Required to publish."
        }
      }
    },
    "request_candidate_availability": {
      "type": "boolean",
      "description": "A Boolean indicator of whether or not to request a candidate's availability. Defaults to false."
    },
    "skill_criteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "is_required": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not a skill criteria is required."
          },
          "skill": {
            "type": "object",
            "description": "The skill model."
          },
          "proficiency_level": {
            "type": "object",
            "description": "The proficiency level associated with a skill."
          }
        }
      },
      "description": "An array of an opportunity's skill criteria. All skill criteria must have a valid skill ID and proficiency level ID."
    },
    "staffing_plan_impact": {
      "type": "string",
      "description": "An opportunity's impact to staffing plan notes. Defaults to `null`. Maximum 500 characters."
    },
    "supervisor": {
      "type": "object",
      "description": "The supervisor associated with an opportunity.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of an opportunity's supervisor, which must be a valid internal and active candidate."
        }
      }
    },
    "target_start_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "An opportunity's target start date. Defaults to `null`."
    },
    "title": {
      "type": "object",
      "description": "The title of an opportunity in all available languages. Maximum of 75 characters. Required to publish.",
      "properties": {
        "en_gb": {
          "type": "string",
          "description": "The UK English rendering of the opportunity title."
        },
        "en_us": {
          "type": "string",
          "description": "The US English rendering of the opportunity title."
        }
      }
    },
    "travel": {
      "type": "object",
      "description": "The travel model for an opportunity.",
      "properties": {
        "is_required": {
          "type": "boolean",
          "description": "A Boolean indicator of whether or not travel is required."
        },
        "details": {
          "type": "object",
          "description": "An opportunity's travel description in all available languages. Maximum 75 characters. Optional."
        }
      }
    },
    "work_experience_criteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "is_required": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not a work experience criteria is required by an opportunity."
          },
          "minimum_required_years": {
            "type": "integer",
            "description": "The minimum number of years required by an opportunity."
          },
          "maximum_required_years": {
            "type": "integer",
            "description": "The maximum number of years required by an opportunity."
          },
          "description": {
            "type": "object",
            "description": "The description of a work experience criteria in all available languages."
          }
        }
      },
      "description": "An array of an opportunity's work experience criteria. All work experiences must have a translation for the opportunity's default language code."
    }
  },
  "required": [
    "PCID",
    "tenantalias"
  ]
}

---

ukg-recruiting-pipeline_create_opportunity_assessment

Create Opportunity Assessment

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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
integration_id	string	No	—	The unique ID of an integration in GUID format.
packages	object[]	No	—	An array of packages.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "integration_id": {
      "type": "string",
      "description": "The unique ID of an integration in GUID format."
    },
    "packages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique ID of a package in GUID format."
          }
        }
      },
      "description": "An array of packages."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId"
  ]
}

---

ukg-recruiting-pipeline_create_opportunity_screening_question

Create Opportunity Screening Question

Parameters:

Parameter	Type	Required	Default	Description
opportunityId	string	Yes	—	The unique ID of an opportunity.
tenantalias	string	Yes	—	The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
choices	object[]	No	—	An array of answer choices. A minimum of two valid choices is required.
is_disqualifying	boolean	null	No	—	A Boolean indicator of whether or not an incorrect response to a particular opportunity screening question is disqualifying.
library_question	string	null	No	—	The library question.
ordinal	number	No	—	The ordinal number assigned to a screening question consisting of a whole number greater than zero that cannot be a ordinal already asigned to another screening question in the opportunity. If not specified, the next-to-maximum ordinal in the screening question collection is assigned.
question	object	No	—	The screening question in all available languages.
range	object	No	—	The range associated with a numeric screening question.
score	number	No	—	A whole number in the 0 to 5 range.
type	string	No	—	The type of screening question. Valid values include Text, Numeric, and MultipleChoice.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "tenantalias": {
      "type": "string",
      "description": "The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
    },
    "choices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "object",
            "description": "An array of translations in all supported languages. A translation in the tenant's default locale is required for a non-empty choice section. The string supports a maximum of 400 characters."
          },
          "is_correct": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not an answer is correct."
          },
          "is_disqualifying": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not an answer is disqualifying."
          }
        }
      },
      "description": "An array of answer choices. A minimum of two valid choices is required."
    },
    "is_disqualifying": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "A Boolean indicator of whether or not an incorrect response to a particular opportunity screening question is disqualifying."
    },
    "library_question": {
      "type": [
        "string",
        "null"
      ],
      "description": "The library question."
    },
    "ordinal": {
      "type": "number",
      "description": "The ordinal number assigned to a screening question consisting of a whole number greater than zero that cannot be a ordinal already asigned to another screening question in the opportunity. If not specified, the next-to-maximum ordinal in the screening question collection is assigned."
    },
    "question": {
      "type": "object",
      "description": "The screening question in all available languages.",
      "properties": {
        "en_us": {
          "type": "string",
          "description": "The US English rendering of the proficiency level name."
        }
      }
    },
    "range": {
      "type": "object",
      "description": "The range associated with a numeric screening question.",
      "properties": {
        "minimum": {
          "type": "integer",
          "description": "A whole number in the -99999999 to 999999999 range."
        },
        "maximum": {
          "type": "integer",
          "description": "A whole number in the -99999999 to 999999999 range that must be greater than or equal to the minimum value."
        }
      }
    },
    "score": {
      "type": "number",
      "description": "A whole number in the 0 to 5 range."
    },
    "type": {
      "type": "string",
      "description": "The type of screening question. Valid values include `Text`, `Numeric`, and `MultipleChoice`."
    }
  },
  "required": [
    "PCID",
    "opportunityId",
    "tenantalias"
  ]
}

---

ukg-recruiting-pipeline_deactivate_opportunity_screening_questions

Deactivate Opportunity Screening Questions

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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
screeningQuestionId	string	Yes	—	The unique ID of a screening question.
is_active	boolean	No	—	Is Active

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "screeningQuestionId": {
      "type": "string",
      "description": "The unique ID of a screening question."
    },
    "is_active": {
      "type": "boolean",
      "description": "Is Active"
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId",
    "screeningQuestionId"
  ]
}

---

ukg-recruiting-pipeline_delete_opportunity_assessment_by_id

Delete Opportunity Assessment 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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
opportunityAssessmentId	string	Yes	—	The unique ID of an opportunity assessment.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "opportunityAssessmentId": {
      "type": "string",
      "description": "The unique ID of an opportunity assessment."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId",
    "opportunityAssessmentId"
  ]
}

---

ukg-recruiting-pipeline_disposition_application_by_id

Disposition Application by ID

Parameters:

Parameter	Type	Required	Default	Description
tenantalias	string	Yes	—	The customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
applicationId	string	Yes	—	The unique ID of an application.
author	object	No	—	The author value
comment	string	No	—	Any comments the recruiter wants to leave about the dispositioning.
created_at	string	No	—	Timestamp for the dispositioning. Defaults to NOW if not provided. Must not be future dated, before the applied date, and must be after the applications step begin date.
disposition_reason	object	No	—	The disposition reason model.
is_important	boolean	No	—	A boolean indicator of whether the comment is important or not. Defaults to FALSE if not provided.
step	object	No	—	The step model.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "tenantalias": {
      "type": "string",
      "description": "The customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
    },
    "applicationId": {
      "type": "string",
      "description": "The unique ID of an application."
    },
    "author": {
      "type": "object",
      "description": "The author value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the recruiter performing this action. The author must have access to the applications opportunity."
        }
      },
      "required": [
        "id"
      ]
    },
    "comment": {
      "type": "string",
      "description": "Any comments the recruiter wants to leave about the dispositioning."
    },
    "created_at": {
      "type": "string",
      "description": "Timestamp for the dispositioning. Defaults to NOW if not provided. Must not be future dated, before the applied date, and must be after the applications step begin date."
    },
    "disposition_reason": {
      "type": "object",
      "description": "The disposition reason model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the reason for the dispositioning. Reason must exist and must not be archived."
        }
      }
    },
    "is_important": {
      "type": "boolean",
      "description": "A boolean indicator of whether the comment is important or not. Defaults to FALSE if not provided."
    },
    "step": {
      "type": "object",
      "description": "The step model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The step to disposition the application to. If the opportunity is closed, only the rejected step is valid.  Must not be the recruiting process's initial step or current step."
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "applicationId"
  ]
}

---

ukg-recruiting-pipeline_initiate_hire_by_application_id

Initiate Hire by Application 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.
applicationId	string	Yes	—	The unique ID of an application.
accept_date	string	Yes	—	The date on which the offer was accepted by a candidate for the specified application. Must not be before 1/1/1881 or after 12/31/2199.
company	object	No	—	The company model.
compensation	object	No	—	The compensation model.
employee_type	object	No	—	The employee type model.
fte	number	No	—	The full time equivalent of the hire (decimal). Must be greater than 0 and no more than 9999999999 .9999 Required (if FTE enabled).
hire_date	string	Yes	—	The date on which the candidate is hired for the opportunity associated with the specified application. Must not be before 1/1/1881 or after 12/31/2199.
hiring_manager	object	No	—	The hiring manager associated with the hire.
offer_date	string	Yes	—	The date on which the offer was presented to a candidate for the specified application. Must not be before 1/1/1881 or after 12/31/2199.
onboarding_owner	object	No	—	The onboarding owner for the hire.
org_units	object[]	No	—	Array of OrgUnit IDs
start_date	string	Yes	—	The date on which the candidate is set to start working. Must not be before 1/1/1881 or after 12/31/2199.
supervisor	object	No	—	The supervisor model.
tax_location	object	No	—	The tax location model.

Show inputSchema

{
  "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."
    },
    "applicationId": {
      "type": "string",
      "description": "The unique ID of an application."
    },
    "accept_date": {
      "type": "string",
      "description": "The date on which the offer was accepted by a candidate for the specified application.  Must not be before 1/1/1881 or after 12/31/2199."
    },
    "company": {
      "type": "object",
      "description": "The company model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the legal entity associated with the specified application. If not specified, it defaults to the legal entity associated with the opportunity for the application."
        }
      }
    },
    "compensation": {
      "type": "object",
      "description": "The compensation model.",
      "properties": {
        "is_fulltime": {
          "type": "string",
          "description": "A Boolean indicator of whether or not the applicant is full-time. If false, the applicant is part-time. If not specified, defaults to `true`."
        },
        "hours_per_week": {
          "type": "string",
          "description": "The hours per week of the applicant.  Must not be less than 0 or greater than 999999999.99."
        },
        "is_salaried": {
          "type": "string",
          "description": "A Boolean indicator of whether or not an applicant is salaried. If false, the applicant is hourly."
        },
        "pay_rate": {
          "type": "string",
          "description": "The USD pay rate for the applicant.  If supplied, must not be less than 0, greater than 99999999999999.9999, or have a decimal with more than 4 digits."
        },
        "currency ": {
          "type": "object",
          "description": "The currency value"
        }
      },
      "required": [
        "is_salaried"
      ]
    },
    "employee_type": {
      "type": "object",
      "description": "The employee type model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The applicant's employeeType. Must be one of the currently available employee types. Employee types can be retrieved by calling GET http://{{host}}/{{tenantalias}}/api/integration-code-mappings/?type=17 request."
        }
      }
    },
    "fte": {
      "type": "number",
      "description": "The full time equivalent of the hire (decimal).  Must be greater than 0 and no more than 9999999999 .9999 Required (if FTE enabled)."
    },
    "hire_date": {
      "type": "string",
      "description": "The date on which the candidate is hired for the opportunity associated with the specified application.  Must not be before 1/1/1881 or after 12/31/2199."
    },
    "hiring_manager": {
      "type": "object",
      "description": "The hiring manager associated with the hire.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the hiring manager for the opportunity associated with the specified application."
        }
      }
    },
    "offer_date": {
      "type": "string",
      "description": "The date on which the offer was presented to a candidate for the specified application.  Must not be before 1/1/1881 or after 12/31/2199."
    },
    "onboarding_owner": {
      "type": "object",
      "description": "The onboarding owner for the hire.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the onboarding owner for the opportunity associated with the specified application."
        }
      }
    },
    "org_units": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The org unit ID."
          }
        }
      },
      "description": "Array of OrgUnit IDs"
    },
    "start_date": {
      "type": "string",
      "description": "The date on which the candidate is set to start working.  Must not be before 1/1/1881 or after 12/31/2199."
    },
    "supervisor": {
      "type": "object",
      "description": "The supervisor model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the supervisor for the opportunity associated with the specified application."
        }
      }
    },
    "tax_location": {
      "type": "object",
      "description": "The tax location model.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the tax location associated with the legal entity for the specified application."
        }
      }
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "applicationId",
    "accept_date",
    "hire_date",
    "offer_date",
    "start_date"
  ]
}

---

ukg-recruiting-pipeline_look_up_easy_apply_application_by_candidate_opportunity_and_integration_id

Look Up EasyApply Application by Candidate, Opportunity, and Integration 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.
candidate	object	No	—	The candidate believed to be associated with the application.
integration	object	No	—	The requesting partner.
opportunity	object	No	—	The opportunity believed to be associated with the application.

Show inputSchema

{
  "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."
    },
    "candidate": {
      "type": "object",
      "description": "The candidate believed to be associated with the application.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique ID of a candidate in GUID format."
        }
      }
    },
    "integration": {
      "type": "object",
      "description": "The requesting partner.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique ID of the requesting partner in GUID format."
        }
      }
    },
    "opportunity": {
      "type": "object",
      "description": "The opportunity believed to be associated with the application.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique ID of the opportunity in GUID format."
        }
      }
    }
  },
  "required": [
    "PCID",
    "tenantalias"
  ]
}

---

ukg-recruiting-pipeline_publish_opportunity_by_id

Publish Opportunity 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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
published_date	string	No	—	The date and time on and at which an opportunity is published.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "published_date": {
      "type": "string",
      "description": "The date and time on and at which an opportunity is published."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId"
  ]
}

---

ukg-recruiting-pipeline_refresh_opportunity_by_id

Refresh Opportunity 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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
external	boolean	No	—	A Boolean indicator of whether or not to refresh the external job board.
internal	boolean	No	—	A Boolean indicator of whether or not to refresh the internal job board.
job_board_id	string	No	—	The unique ID of the job board whose postings will be refreshed in GUID format.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "external": {
      "type": "boolean",
      "description": "A Boolean indicator of whether or not to refresh the external job board."
    },
    "internal": {
      "type": "boolean",
      "description": "A Boolean indicator of whether or not to refresh the internal job board."
    },
    "job_board_id": {
      "type": "string",
      "description": "The unique ID of the job board whose postings will be refreshed in GUID format."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_all_opportunity_assessments

Retrieve All Opportunity Assessments

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.
opportunityId	string	Yes	—	The unique ID of an opportunity.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_application_by_id

Retrieve Application 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.
applicationId	string	Yes	—	The unique ID of an application.

Show inputSchema

{
  "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."
    },
    "applicationId": {
      "type": "string",
      "description": "The unique ID of an application."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "applicationId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_application_disposition_events

Retrieve Application Disposition Events

Parameters:

Parameter	Type	Required	Default	Description
tenantalias	string	Yes	—	The customer tenant. Can be viewed in the 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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "tenantalias": {
      "type": "string",
      "description": "The customer tenant. Can be viewed in the 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-pipeline_retrieve_application_disposition_events_by_application_id

Retrieve Application Disposition Events by Application ID

Parameters:

Parameter	Type	Required	Default	Description
tenantalias	string	Yes	—	The customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.
applicationId	string	Yes	—	The unique ID of an application.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "tenantalias": {
      "type": "string",
      "description": "The customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
    },
    "applicationId": {
      "type": "string",
      "description": "The unique ID of an application."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "applicationId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_applications

Retrieve Applications

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 paginated records to return.
per_page	string	No	—	The number of resources returned per page. If no pagination parameters are specified, the default (max) is applied.
updated_after	string	No	—	The filtering date on or after which applications were updated. UTC values are required for accurate results since DateTime values are UTC. For example: 2016-12-21T18:44:03.356Z. No quoted value. The system ignores this parameter if the value is not a properly formatted DateTime. Milliseconds are also applied to the filter.
updated_before	string	No	—	The filtering date on or before which applications were updated. UTC values are required for accurate results since DateTime values are UTC. For example: 2016-12-21T18:44:03.356Z. No quoted value. The system ignores this parameter if the value is not a properly formatted DateTime. Milliseconds are also applied to the filter.

Show inputSchema

{
  "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 paginated records to return."
    },
    "per_page": {
      "type": "string",
      "description": "The number of resources returned per page. If no pagination parameters are specified, the default (max) is applied."
    },
    "updated_after": {
      "type": "string",
      "description": "The filtering date on or after which applications were updated. UTC values are required for accurate results since DateTime values are UTC. For example: 2016-12-21T18:44:03.356Z. No quoted value. The system ignores this parameter if the value is not a properly formatted DateTime.  Milliseconds are also applied to the filter."
    },
    "updated_before": {
      "type": "string",
      "description": "The filtering date on or before which applications were updated. UTC values are required for accurate results since DateTime values are UTC. For example: 2016-12-21T18:44:03.356Z. No quoted value. The system ignores this parameter if the value is not a properly formatted DateTime.  Milliseconds are also applied to the filter."
    }
  },
  "required": [
    "PCID",
    "tenantalias"
  ]
}

---

ukg-recruiting-pipeline_retrieve_applications_by_candidate_id

Retrieve Applications by Candidate 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.
candidateId	string	Yes	—	The unique ID of a candidate.
page	string	No	—	The page of paginated records to return.
per_page	string	No	—	The number of resources returned per page. Default is 50, maximum is 1000.
after	string	No	—	Returns records after this ID.
before	string	No	—	Return records before this ID.
updated_after	string	No	—	Filter applications updated on or after this date. UTC DateTime format required. Example: 2016-12-21T18:44:03.356Z
updated_before	string	No	—	Filter applications updated on or before this date. UTC DateTime format required. Example: 2016-12-21T18:44:03.356Z
job_code	string	No	—	Filter applications by job code. Only returns applications where the job code matches the specified value.

Show inputSchema

{
  "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."
    },
    "candidateId": {
      "type": "string",
      "description": "The unique ID of a candidate."
    },
    "page": {
      "type": "string",
      "description": "The page of paginated records to return."
    },
    "per_page": {
      "type": "string",
      "description": "The number of resources returned per page. Default is 50, maximum is 1000."
    },
    "after": {
      "type": "string",
      "description": "Returns records after this ID."
    },
    "before": {
      "type": "string",
      "description": "Return records before this ID."
    },
    "updated_after": {
      "type": "string",
      "description": "Filter applications updated on or after this date. UTC DateTime format required. Example: 2016-12-21T18:44:03.356Z"
    },
    "updated_before": {
      "type": "string",
      "description": "Filter applications updated on or before this date. UTC DateTime format required. Example: 2016-12-21T18:44:03.356Z"
    },
    "job_code": {
      "type": "string",
      "description": "Filter applications by job code. Only returns applications where the job code matches the specified value."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "candidateId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_comments_by_application_id

Retrieve Comments by Application 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.
applicationId	string	Yes	—	The unique ID of an application.

Show inputSchema

{
  "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."
    },
    "applicationId": {
      "type": "string",
      "description": "The unique ID of an application."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "applicationId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_offer_actions_by_offer_id

Retrieve Offer Actions by Offer 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.
offerId	string	Yes	—	The unique ID of an offer.
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.

Show inputSchema

{
  "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."
    },
    "offerId": {
      "type": "string",
      "description": "The unique ID of an offer."
    },
    "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",
    "offerId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_offers

Retrieve Offers

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.

Show inputSchema

{
  "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-pipeline_retrieve_opportunities

Retrieve Opportunities

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.

Show inputSchema

{
  "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-pipeline_retrieve_opportunity_assessment_by_id

Retrieve Opportunity Assessment 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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
opportunityAssessmentId	string	Yes	—	The unique ID of an opportunity assessment.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "opportunityAssessmentId": {
      "type": "string",
      "description": "The unique ID of an opportunity assessment."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId",
    "opportunityAssessmentId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_opportunity_by_id

Retrieve Opportunity 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.
opportunityId	string	Yes	—	The unique ID of an opportunity.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_opportunity_country_questions

Retrieve Opportunity Country Questions

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.
opportunityId	string	Yes	—	The unique ID of an opportunity.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId"
  ]
}

---

ukg-recruiting-pipeline_retrieve_opportunity_screening_questions

Retrieve Opportunity Screening Questions

Parameters:

Parameter	Type	Required	Default	Description
opportunityId	string	Yes	—	The unique ID of an opportunity.
tenantalias	string	Yes	—	The customer tenant. May be seen in browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "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",
    "opportunityId",
    "tenantalias"
  ]
}

---

ukg-recruiting-pipeline_retrieve_recruiters_an_opportunity_is_shared_with

Retrieve Recruiters an Opportunity is Shared With

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.
opportunityId	string	Yes	—	The unique ID of an opportunity.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId"
  ]
}

---

ukg-recruiting-pipeline_share_opportunity_with_recruiter

Share Opportunity With Recruiter

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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
person	object	No	—	The Person model.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "person": {
      "type": "object",
      "description": "The Person model."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId"
  ]
}

---

ukg-recruiting-pipeline_submit_offer_for_approval_by_id

Submit Offer for Approval 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.
offerId	string	Yes	—	The unique ID of an offer.
author	object	No	—	The author of the offer.

Show inputSchema

{
  "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."
    },
    "offerId": {
      "type": "string",
      "description": "The unique ID of an offer."
    },
    "author": {
      "type": "object",
      "description": "The author of the offer.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the author in GUID format."
        }
      }
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "offerId"
  ]
}

---

ukg-recruiting-pipeline_update_opportunity_assessment_by_id

Update Opportunity Assessment 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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
opportunityAssessmentId	string	Yes	—	The unique ID of an opportunity assessment.
id	string	No	—	The unique ID of an opportunity assessment in GUID format.
ordinal	number	No	—	The ordinal assigned to this opportunity assessment.
packages	object[]	No	—	An array of packages.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "opportunityAssessmentId": {
      "type": "string",
      "description": "The unique ID of an opportunity assessment."
    },
    "id": {
      "type": "string",
      "description": "The unique ID of an opportunity assessment in GUID format."
    },
    "ordinal": {
      "type": "number",
      "description": "The ordinal assigned to this opportunity assessment."
    },
    "packages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique ID of a package in GUID format."
          }
        }
      },
      "description": "An array of packages."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId",
    "opportunityAssessmentId"
  ]
}

---

ukg-recruiting-pipeline_update_opportunity_screening_question_by_id

Update Opportunity Screening Question 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.
opportunityId	string	Yes	—	The unique ID of an opportunity.
screeningQuestionId	string	Yes	—	The unique ID of a screening question.
choices	object[]	No	—	An array of answer choices. A minimum of two valid choices is required.
is_disqualifying	boolean	null	No	—	A Boolean indicator of whether or not an incorrect response to a particular opportunity screening question is disqualifying.
library_question	string	null	No	—	The library question.
ordinal	number	No	—	The ordinal number assigned to a screening question consisting of a whole number greater than zero that cannot be a ordinal already asigned to another screening question in the opportunity. If not specified, the next-to-maximum ordinal in the screening question collection is assigned.
question	object	No	—	The screening question in all available languages.
range	object	No	—	The range associated with a numeric screening question.
score	number	No	—	A whole number in the 0 to 5 range.
type	string	No	—	The type of screening question. Valid values include Text, Numeric, and MultipleChoice.

Show inputSchema

{
  "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."
    },
    "opportunityId": {
      "type": "string",
      "description": "The unique ID of an opportunity."
    },
    "screeningQuestionId": {
      "type": "string",
      "description": "The unique ID of a screening question."
    },
    "choices": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "object",
            "description": "An array of translations in all supported languages. A translation in the tenant's default locale is required for a non-empty choice section. The string supports a maximum of 400 characters."
          },
          "is_correct": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not an answer is correct."
          },
          "is_disqualifying": {
            "type": "boolean",
            "description": "A Boolean indicator of whether or not an answer is disqualifying."
          }
        }
      },
      "description": "An array of answer choices. A minimum of two valid choices is required."
    },
    "is_disqualifying": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "A Boolean indicator of whether or not an incorrect response to a particular opportunity screening question is disqualifying."
    },
    "library_question": {
      "type": [
        "string",
        "null"
      ],
      "description": "The library question."
    },
    "ordinal": {
      "type": "number",
      "description": "The ordinal number assigned to a screening question consisting of a whole number greater than zero that cannot be a ordinal already asigned to another screening question in the opportunity. If not specified, the next-to-maximum ordinal in the screening question collection is assigned."
    },
    "question": {
      "type": "object",
      "description": "The screening question in all available languages.",
      "properties": {
        "en_us": {
          "type": "string",
          "description": "The US English rendering of the proficiency level name."
        }
      }
    },
    "range": {
      "type": "object",
      "description": "The range associated with a numeric screening question.",
      "properties": {
        "minimum": {
          "type": "integer",
          "description": "A whole number in the -99999999 to 999999999 range."
        },
        "maximum": {
          "type": "integer",
          "description": "A whole number in the -99999999 to 999999999 range that must be greater than or equal to the minimum value."
        }
      }
    },
    "score": {
      "type": "number",
      "description": "A whole number in the 0 to 5 range."
    },
    "type": {
      "type": "string",
      "description": "The type of screening question. Valid values include `Text`, `Numeric`, and `MultipleChoice`."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "opportunityId",
    "screeningQuestionId"
  ]
}

---

ukg-recruiting-pipeline_upload_application_document

Upload Application Document

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.
applicationId	string	Yes	—	The unique ID of an application.
file	string	No	—	The uploaded file, consisting of the file’s name and extension (example: file.doc). The file name cannot be empty, white-space, or contain any of the following characters: /\?:*”<>| The extension cannot be empty, white-space, or consist of any non-supported file type. Supported file types are: .jpg, .jpeg, .png, .pdf, .doc, and .docx.
metadata	string	No	—	The metadata associated with an uploaded file.

Show inputSchema

{
  "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."
    },
    "applicationId": {
      "type": "string",
      "description": "The unique ID of an application."
    },
    "file": {
      "type": "string",
      "description": "The uploaded file, consisting of the file's name and extension (example: file.doc).  The file name cannot be empty, white-space, or contain any of the following characters: /&bsol;?:*&quot;<>|  The extension cannot be empty, white-space, or consist of any non-supported file type. Supported file types are: .jpg, .jpeg, .png, .pdf, .doc, and .docx."
    },
    "metadata": {
      "type": "string",
      "description": "The metadata associated with an uploaded file."
    }
  },
  "required": [
    "PCID",
    "tenantalias",
    "applicationId"
  ]
}