/ukg-recruiting-candidates | Type: Application | PCID required: Yes
Tools
ukg-recruiting-candidates_add_behaviorby_candidate_id
Add Behavior 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. |
id | string | Yes | — | The GUID of the behavior. Must be existing, not archived and unique for the candidate. |
Show inputSchema
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."
},
"id": {
"type": "string",
"description": "The GUID of the behavior. Must be existing, not archived and unique for the candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"id"
]
}
ukg-recruiting-candidates_add_comment_by_candidate_id
Add Comment by Candidate ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. Can be seen in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
candidateId | string | Yes | — | The unique ID of a candidate. |
author | object | No | — | The author model. |
comment | string | Yes | — | The comment text. Cannot be empty or contain only whitespace. Maximum of 4000 characters. |
created_at | string | No | — | The date and time of creation. A UTC value. For example: 2016-12-20T11:24:06.726Z. |
is_important | boolean | No | — | A boolean indicating if the comment is important. Can only be specified when is_important is true. |
Show inputSchema
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 seen in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
},
"author": {
"type": "object",
"description": "The author model.",
"properties": {
"id": {
"type": "string",
"description": "The ID that is associated with the person. The person must be an internal candidate."
}
},
"required": [
"id"
]
},
"comment": {
"type": "string",
"description": "The comment text. Cannot be empty or contain only whitespace. Maximum of 4000 characters."
},
"created_at": {
"type": "string",
"description": "The date and time of creation. A UTC value. For example: 2016-12-20T11:24:06.726Z."
},
"is_important": {
"type": "boolean",
"description": "A boolean indicating if the comment is important. Can only be specified when is_important is true."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"comment"
]
}
ukg-recruiting-candidates_add_education_by_candidate_id
Add Education by Candidate ID Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
tenantalias | string | Yes | — | Identifies the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. | |
candidateId | string | Yes | — | The unique ID of a candidate. | |
degree | object | No | — | The degree value | |
description | string | null | No | — | A description of the candidate’s time at school. |
from | object | No | — | The attended from model. | |
major | object | No | — | The candidate’s major degree model. | |
minor | object | No | — | The candidate’s minor degree model. | |
school | object | No | — | The school ID in UKG Pro Recruiting. | |
to | object | No | — | The attended to model. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "Identifies the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
},
"degree": {
"type": "object",
"description": "The degree value",
"properties": {
"id": {
"type": "string",
"description": "The ID of a degree you want to add to candidates education."
},
"name": {
"type": "string",
"description": "Name of the new degree you want to add to candidates education. Required if id is not supplied"
}
}
},
"description": {
"type": [
"string",
"null"
],
"description": "A description of the candidate's time at school."
},
"from": {
"type": "object",
"description": "The attended from model.",
"properties": {
"month": {
"type": "integer",
"description": "A value between 1 and 12 of the month when the education started."
},
"year": {
"type": "integer",
"description": "An integer no less than 100 years ago and no greater than the to year indicating when the education started."
}
}
},
"major": {
"type": "object",
"description": "The candidate's major degree model.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the major for the education."
}
}
},
"minor": {
"type": "object",
"description": "The candidate's minor degree model.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the minor for the education."
}
}
},
"school": {
"type": "object",
"description": "The school ID in UKG Pro Recruiting.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the school you want to add to candidates education."
},
"name": {
"type": "string",
"description": "The name of the school you want to give the the candidate education. Required when an ID is not supplied."
}
}
},
"to": {
"type": "object",
"description": "The attended to model.",
"properties": {
"month": {
"type": "integer",
"description": "A value between 1 and 12 of the month when the education was or will be finished."
},
"year": {
"type": "integer",
"description": "An integer no less than 100 years ago and no greater than 5 years from now indicating the year when the education was or will be finished."
}
}
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_add_license_by_candidate_id
Add License by Candidate ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | An identifier for the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
candidateId | string | Yes | — | A unique identifier for the candidate. |
achieved_date | string | No | — | The license achieved date. Cannot be more than 100 years in the past or 5 years in the future. Cannot be greater than renewal_date. |
license | object | No | — | The license model. |
number | string | No | — | The license number. Maximum length of 20. |
renewal_date | string | No | — | The license renewal date. Cannot be less than achieved_date. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "An identifier for the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"candidateId": {
"type": "string",
"description": "A unique identifier for the candidate."
},
"achieved_date": {
"type": "string",
"description": "The license achieved date. Cannot be more than 100 years in the past or 5 years in the future. Cannot be greater than renewal_date."
},
"license": {
"type": "object",
"description": "The license model.",
"properties": {
"id": {
"type": "string",
"description": "The ID of an existing license that you want to add to candidate. Required when a name is not supplied."
},
"name": {
"type": "string",
"description": "The name of the new license you want to add to candidate. Maximum length of 250. Required if the ID is not supplied."
}
}
},
"number": {
"type": "string",
"description": "The license number. Maximum length of 20."
},
"renewal_date": {
"type": "string",
"description": "The license renewal date. Cannot be less than achieved_date."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_add_motivation_by_candidate_id
Add Motivation by Candidate 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
id | string | Yes | — | The GIUD of the motivation. Must be existing, not archived and unique for the candidate. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
},
"id": {
"type": "string",
"description": "The GIUD of the motivation. Must be existing, not archived and unique for the candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"id"
]
}
ukg-recruiting-candidates_add_reference_by_candidate_id
Add Reference by Candidate 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. | |
candidateId | string | Yes | — | The unique ID of a candidate. | |
company | string | null | No | — | The reference person’s company. Maximum of 50 characters. |
contact_info | object | No | — | The contact information model. | |
job_title | string | null | No | — | The job title for the reference. |
name | object | No | — | The name model. | |
recommendation | object | No | — | The recommendation model. | |
relationship | string | null | No | — | Accepted values: Personal/Professional. Non sensitive. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
},
"company": {
"type": [
"string",
"null"
],
"description": "The reference person's company. Maximum of 50 characters."
},
"contact_info": {
"type": "object",
"description": "The contact information model.",
"properties": {
"email": {
"type": "string",
"description": "The reference person's e-mail. Maximum of 254 character."
},
"phone": {
"type": "string",
"description": "The reference person's phone number. Maximum of 20 characters."
}
}
},
"job_title": {
"type": [
"string",
"null"
],
"description": "The job title for the reference."
},
"name": {
"type": "object",
"description": "The name model.",
"properties": {
"first": {
"type": "string",
"description": "The reference peson's first name. Maximum of 100 characters."
},
"middle": {
"type": "string",
"description": "The reference person's middle name. Maximum of 50 characters."
},
"last": {
"type": "string",
"description": "The reference peson's last name. Maxiumu of 100 characters."
},
"prefix": {
"type": "object",
"description": "The prefix model."
},
"suffix": {
"type": "object",
"description": "The suffix model."
}
},
"required": [
"first",
"last"
]
},
"recommendation": {
"type": "object",
"description": "The recommendation model.",
"properties": {
"requested_at": {
"type": "string",
"description": "The date and time of the request."
},
"recommended_at": {
"type": "string",
"description": "The date and time of the recommendation."
},
"text": {
"type": "string",
"description": "The text of the recomendation. Required only if a recomended date is provided"
}
},
"required": [
"text"
]
},
"relationship": {
"type": [
"string",
"null"
],
"description": "Accepted values: Personal/Professional. Non sensitive."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_add_skill_by_candidate_id
Add Skill by Candidate 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
proficiency_level | object | No | — | The proficiency level model. |
skill | object | No | — | The skill model. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
},
"proficiency_level": {
"type": "object",
"description": "The proficiency level model.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the proficiency level that applies to the candidate's skill. Use the GET proficiency-levels endpoint to retrieve proficiency level IDs."
}
},
"required": [
"id"
]
},
"skill": {
"type": "object",
"description": "The skill model.",
"properties": {
"name": {
"type": "string",
"description": "The name of the skill to add to the candidate. Must be between 1 and 80 characters."
},
"id": {
"type": "string",
"description": "The ID of the skill you want to add to the candidate. Required if a name is not supplied."
}
}
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_add_work_experience_by_candidate_id
Add Work Experience by Candidate 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. | |
candidateId | string | Yes | — | The unique ID of a candidate. | |
company | string | Yes | — | The company name of the experience. Maximum of 100 characters. | |
description | string | null | No | — | A description of the responsibilities and roles performed at the job. Maximum of 2000 characters |
from | object | No | — | The worked from model. | |
job_title | string | Yes | — | The job title of the experience. Maxiumum of 100 characters. | |
location | string | null | No | — | The location where the job was located. Maximum of 20 characters. |
to | object | No | — | The attended to model. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
},
"company": {
"type": "string",
"description": "The company name of the experience. Maximum of 100 characters."
},
"description": {
"type": [
"string",
"null"
],
"description": "A description of the responsibilities and roles performed at the job. Maximum of 2000 characters"
},
"from": {
"type": "object",
"description": "The worked from model.",
"properties": {
"month": {
"type": "integer",
"description": "The month number of the start date for the job. Can be 1 through 12."
},
"year": {
"type": "integer",
"description": "Required only if from.month, to.month or to.year is provided. The year number of the start date for the job. Cannot be earlier than 100 years from present nor greater than 5 from present. An empty value should only be used for migration purposes (already hired candidates), otherwise it will create issues in On Boarding."
}
}
},
"job_title": {
"type": "string",
"description": "The job title of the experience. Maxiumum of 100 characters."
},
"location": {
"type": [
"string",
"null"
],
"description": "The location where the job was located. Maximum of 20 characters."
},
"to": {
"type": "object",
"description": "The attended to model.",
"properties": {
"month": {
"type": "integer",
"description": "The month number of the end date for the job. Can be 1 through 12."
},
"year": {
"type": "integer",
"description": "The year number of the end date for the job. Cannot be earlier than 100 years from present nor greater than 5 from present. Required only if the to.month is provided. A combination of to.month/to.year must be greater or equal to from.month/from.year. This only applies when the 4 values are provided."
}
}
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"company",
"job_title"
]
}
ukg-recruiting-candidates_create_assessment_by_id
Create Assessment by ID Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
tenantalias | string | Yes | — | An identifier for the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. | |
candidateId | string | Yes | — | A unique identifier of the candidate. | |
application | object | No | — | The application model. | |
assessment_integration | object | No | — | The assessment integration model. | |
assessment_packages | object[] | No | — | An array of assessment packages. | |
assessment_results | string | null | No | — | The assessment results. |
assessment_url | string | null | No | — | The assessment url. Maximum of 2000 chars. Must start with “https://”. |
failure_status_description | string | null | No | — | The failure status description. Maximum of 100 characters. |
requested_date | string | No | — | The requested at date and time. | |
status | string | Yes | — | One of the values from the enumerated list: * Generating * NotStarted * InProgress * Abandoned * OptedOut * Completed * Deferred * Expired * Retrying * Failed * NotSent | |
status_changed_date | string | No | — | The timestamp of the last time the status changed. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "An identifier for the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"candidateId": {
"type": "string",
"description": "A unique identifier of the candidate."
},
"application": {
"type": "object",
"description": "The application model.",
"properties": {
"id": {
"type": "string",
"description": "The application ID provided in the POST assessment-link-request."
}
},
"required": [
"id"
]
},
"assessment_integration": {
"type": "object",
"description": "The assessment integration model.",
"properties": {
"id": {
"type": "string",
"description": "The assessment integration ID provided by UKG after the provider's integration is registered. Also provided in the POST assessment-link-request."
}
},
"required": [
"id"
]
},
"assessment_packages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The assessment package ID."
},
"package_code": {
"type": "string",
"description": "The assessment package code."
}
}
},
"description": "An array of assessment packages."
},
"assessment_results": {
"type": [
"string",
"null"
],
"description": "The assessment results."
},
"assessment_url": {
"type": [
"string",
"null"
],
"description": "The assessment url. Maximum of 2000 chars. Must start with \"https://”."
},
"failure_status_description": {
"type": [
"string",
"null"
],
"description": "The failure status description. Maximum of 100 characters."
},
"requested_date": {
"type": "string",
"description": "The requested at date and time."
},
"status": {
"type": "string",
"description": "One of the values from the enumerated list: * Generating * NotStarted * InProgress * Abandoned * OptedOut * Completed * Deferred * Expired * Retrying * Failed * NotSent"
},
"status_changed_date": {
"type": "string",
"description": "The timestamp of the last time the status changed."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"status"
]
}
ukg-recruiting-candidates_create_background_check
Create Background Check 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. |
application | object | Yes | — | The application value |
author | object | No | — | The author value |
background_check_integration | object | No | — | Background Check Integration |
order_number | string | Yes | — | The background check order number. Maximum of 100 characters. |
packages | object[] | No | — | An array of background check packages; at most 100. |
status | string | Yes | — | The status of the background check order. Enumerated values: • Unacknowledged, • SentToCandidate, • PendingCandidate, • InProgress, • Completed, • Cancelled, • Archived, • DeclinedByCandidate, • EConsentToCandidate, • New, • PendingRecruiter, • PendingSignature, • Deleted |
Show inputSchema
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."
},
"application": {
"type": "object",
"description": "The application value",
"properties": {
"id": {
"type": "string",
"description": "The id of the corresponding application."
}
},
"required": [
"id"
]
},
"author": {
"type": "object",
"description": "The author value",
"properties": {
"id": {
"type": "string",
"description": "The recruiter who created the order."
}
},
"required": [
"id"
]
},
"background_check_integration": {
"type": "object",
"description": "Background Check Integration",
"properties": {
"id": {
"type": "string",
"description": "The ids of the third party job board integration associated with the order. Must be provided for Partner integration (otherwise, will be defaulted to our current background check vendor)"
}
}
},
"order_number": {
"type": "string",
"description": "The background check order number. Maximum of 100 characters."
},
"packages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the package."
},
"name": {
"type": "object",
"description": "The name of the package in all available languages. Maximum of 100 characters"
},
"screenings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the screening. Enumerated values: • InProgress • Completed • New • Suspended"
},
"name": {
"type": "object",
"description": "The name of the background check screening in all available languages. Maximum of 100 characters."
}
}
},
"description": "An array of background check screenings; at most 100."
}
},
"required": [
"name"
]
},
"description": "An array of background check packages; at most 100."
},
"status": {
"type": "string",
"description": "The status of the background check order. Enumerated values: • Unacknowledged, • SentToCandidate, • PendingCandidate, • InProgress, • Completed, • Cancelled, • Archived, • DeclinedByCandidate, • EConsentToCandidate, • New, • PendingRecruiter, • PendingSignature, • Deleted"
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"application",
"order_number",
"status"
]
}
ukg-recruiting-candidates_create_candidate
Create Candidate 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. | |
behaviors | object[] | No | — | An array containing behavior objects. | |
comments | object[] | No | — | An array containing comment objects. | |
contact_info | object | No | — | The contact information model. | |
creator | object | No | — | The creator model. | |
education | object[] | No | — | An array containing education objects. | |
employment_status | string | null | No | — | The employment status of the candidate. Valid values include: |
hyperlinks | object[] | No | — | An array containing hyperlink objects. | |
integration_user_id | string | null | No | — | The ID of the integration user. Valid only for internal candidates. Only alphanumeric characters and hyphens are allowed. Maximum 50 characters. |
is_active | boolean | null | No | — | A boolean indicator ofwhether the candidate is an active employee. Can only be specified when is_internal is true. |
is_internal | boolean | null | No | — | A boolean indicator of whether the candidate is an internal employee. Default: false. |
is_willing_to_relocate | boolean | null | No | — | A boolean indicating if the candidate it willing to relocate. |
licenses | object[] | No | — | An array of licenses. | |
motivations | object[] | No | — | An array containing motivation objects. | |
name | object | No | — | The name of a candidate. | |
password | string | null | No | — | The password. Must be empty for the Candidate Import API. |
provider | object | No | — | An object containing provider data. | |
skills | object[] | No | — | An array containing skill objects. | |
work_experience | object[] | No | — | An array containing work experience objects. |
Show inputSchema
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."
},
"behaviors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the behavior item in the UKG Pro Recruiting system. The Behavior must be existing, not archived, and unique for the candidate."
}
}
},
"description": "An array containing behavior objects."
},
"comments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"description": "The date of the comment. The value cannot be in the future at the time of the API call."
},
"author": {
"type": "object",
"description": "The author model."
},
"is_important": {
"type": "boolean",
"description": "A boolean indicating if the comment is important."
},
"comment": {
"type": "string",
"description": "The text of the comment. The value cannot be empty or contain only spaces. Maximum 4000 characters."
}
},
"required": [
"author",
"comment"
]
},
"description": "An array containing comment objects."
},
"contact_info": {
"type": "object",
"description": "The contact information model.",
"properties": {
"email": {
"type": "string",
"description": "The candidate's email address. This will also be the username they can use to login. Must be a valid email address. Maximum 254 characters."
},
"phone": {
"type": "object",
"description": "The phone model."
},
"address": {
"type": "object",
"description": "The address model."
}
},
"required": [
"email"
]
},
"creator": {
"type": "object",
"description": "The creator model.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the creator of the candidate record; the creator must exist in the system. Default: null."
}
}
},
"education": {
"type": "array",
"items": {
"type": "object",
"properties": {
"degree": {
"type": "object",
"description": "The degree model."
},
"school": {
"type": "object",
"description": "The school model."
},
"major": {
"type": "object",
"description": "The major degree model."
},
"minor": {
"type": "object",
"description": "The minor degree model."
},
"from": {
"type": "object",
"description": "The attended from model."
},
"to": {
"type": "object",
"description": "The attended to model."
},
"description": {
"type": "string",
"description": "A decription of the education item. Maximum 1500 characters."
}
}
},
"description": "An array containing education objects."
},
"employment_status": {
"type": [
"string",
"null"
],
"description": "The employment status of the candidate. Valid values include:",
"enum": [
"Active",
"LeaveOfAbsence",
"OnStrike",
"Suspended",
"Released",
"Terminated"
]
},
"hyperlinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the hyperlink. Must not be an empty string. Maximum 250 characters."
},
"url": {
"type": "string",
"description": "The URL of the hyperlink. This must be a valid url. For example: https://www.google.com)."
}
},
"required": [
"name",
"url"
]
},
"description": "An array containing hyperlink objects."
},
"integration_user_id": {
"type": [
"string",
"null"
],
"description": "The ID of the integration user. Valid only for internal candidates. Only alphanumeric characters and hyphens are allowed. Maximum 50 characters."
},
"is_active": {
"type": [
"boolean",
"null"
],
"description": "A boolean indicator ofwhether the candidate is an active employee. Can only be specified when is_internal is true."
},
"is_internal": {
"type": [
"boolean",
"null"
],
"description": "A boolean indicator of whether the candidate is an internal employee. Default: false."
},
"is_willing_to_relocate": {
"type": [
"boolean",
"null"
],
"description": "A boolean indicating if the candidate it willing to relocate."
},
"licenses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"license": {
"type": "object",
"description": "The license model."
},
"number": {
"type": "string",
"description": "The license number of the license or certification. Maximum 20 characters."
},
"achieved_date": {
"type": "string",
"description": "The date of completion of the license or certification. At the time of the API request, this value cannot be more than 100 years in the past or 5 years in the future. The value cannot be later than the renewal_date."
},
"renewal_date": {
"type": "string",
"description": "The renewal date of the license or certification. This value cannot be earlier than the achieved_date."
}
}
},
"description": "An array of licenses."
},
"motivations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of a Motivation item in the UKG Pro Recruiting system. The Motivation must be existing, not archived, and unique for the candidate."
}
}
},
"description": "An array containing motivation objects."
},
"name": {
"type": "object",
"description": "The name of a candidate.",
"properties": {
"first": {
"type": "string",
"description": "The candidate's first name. Maximum of 100 characters."
},
"last": {
"type": "string",
"description": "The candidate'slast name. Maximum of 100 characters."
},
"middle": {
"type": "string",
"description": "The candidate's middle name. Maximum of 50 characters."
},
"former": {
"type": "string",
"description": "The candidate's former name. Maximum of 100 characters."
},
"name.preferred": {
"type": "string",
"description": "The candidate's preferred name. Maximum of 100 characters."
},
"prefix": {
"type": "object",
"description": "The prefix model."
},
"suffix": {
"type": "object",
"description": "The suffix model."
}
},
"required": [
"first",
"last"
]
},
"password": {
"type": [
"string",
"null"
],
"description": "The password. Must be empty for the Candidate Import API."
},
"provider": {
"type": "object",
"description": "An object containing provider data.",
"properties": {
"name": {
"type": "string",
"description": "The name of the provider who created the candidate. Maximum of 100 characters."
},
"provider_id": {
"type": "string",
"description": "The ID of provider that generated the candidate. For the Candidate Import API, use: null. For Easy Apply, use integration ID."
},
"type": {
"type": "string",
"description": "The provider type. For the Candidate Import API, use: ThirdPartyIntegration."
},
"method": {
"type": "string",
"description": "The provider method. For the Candidate Import API, use: CandidateImport"
}
}
},
"skills": {
"type": "array",
"items": {
"type": "object",
"properties": {
"skill": {
"type": "object",
"description": "The skill value"
},
"proficiency_level": {
"type": "object",
"description": "The proficiency level model."
}
},
"required": [
"proficiency_level"
]
},
"description": "An array containing skill objects."
},
"work_experience": {
"type": "array",
"items": {
"type": "object",
"properties": {
"job_title": {
"type": "string",
"description": "The job title of the work experience item. Maximum of 100 characters."
},
"company": {
"type": "string",
"description": "The name of the company where the candidate worked in the work experience item."
},
"location": {
"type": "string",
"description": "The location of the candidate's job in the work experience item. Maximum of 20 characters."
},
"from": {
"type": "object",
"description": "The worked from model."
},
"to": {
"type": "object",
"description": "The worked to model."
},
"description": {
"type": "string",
"description": "A description of the work experience item. Maximum 2000 characters."
}
},
"required": [
"job_title",
"company"
]
},
"description": "An array containing work experience objects."
}
},
"required": [
"PCID",
"tenantalias"
]
}
ukg-recruiting-candidates_get_tenant_api_candidates_candidate_id_background_checks
Retrieve Multiple Background Checks 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. |
Show inputSchema
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."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_assessment_by_id
Retrieve Assessment 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. |
candidateid | string | Yes | — | A unique identifier of the candidate. |
assessmentid | string | Yes | — | A GUID provided by UKG after the provider’s integration is registered. Also provided in the POST assessment-link-request. |
Show inputSchema
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."
},
"candidateid": {
"type": "string",
"description": "A unique identifier of the candidate."
},
"assessmentid": {
"type": "string",
"description": "A GUID provided by UKG after the provider's integration is registered. Also provided in the POST assessment-link-request."
}
},
"required": [
"PCID",
"tenantalias",
"candidateid",
"assessmentid"
]
}
ukg-recruiting-candidates_retrieve_assessments_by_candidate_id
Retrieve Assessments by Candidate ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | An identifier for the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
candidateId | string | Yes | — | A unique identifier of the candidate. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "An identifier for the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"candidateId": {
"type": "string",
"description": "A unique identifier of the candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_background_check_by_id
Retrieve Background Check 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
backgroundCheckId | string | Yes | — | The unique ID of a background check. |
Show inputSchema
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."
},
"backgroundCheckId": {
"type": "string",
"description": "The unique ID of a background check."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"backgroundCheckId"
]
}
ukg-recruiting-candidates_retrieve_background_check_order_request
Retrieve Background Check Order Request 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. |
token | string | Yes | — | A temporary Background Check Request token associated with the background check request that has been previously provided by UKG Pro Recruiting in the Background Check Request Redirect URL. |
Show inputSchema
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."
},
"token": {
"type": "string",
"description": "A temporary Background Check Request token associated with the background check request that has been previously provided by UKG Pro Recruiting in the Background Check Request Redirect URL."
}
},
"required": [
"PCID",
"tenantalias",
"token"
]
}
ukg-recruiting-candidates_retrieve_background_check_results_request
Retrieve Background Check Results Request 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. |
token | string | Yes | — | A temporary Background Check Request token associated with the background check request that has been previously provided by UKG Pro Recruiting in the Background Check Request Redirect URL |
Show inputSchema
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."
},
"token": {
"type": "string",
"description": "A temporary Background Check Request token associated with the background check request that has been previously provided by UKG Pro Recruiting in the Background Check Request Redirect URL"
}
},
"required": [
"PCID",
"tenantalias",
"token"
]
}
ukg-recruiting-candidates_retrieve_behaviors_by_candidate_id
Retrieve Behaviors 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. |
Show inputSchema
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."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_candidate_by_email
Retrieve Candidate by Email 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. |
email | string | Yes | — | The e-mail address of the candidate to look up. |
Show inputSchema
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."
},
"email": {
"type": "string",
"description": "The e-mail address of the candidate to look up."
}
},
"required": [
"PCID",
"tenantalias",
"email"
]
}
ukg-recruiting-candidates_retrieve_candidate_by_id
Retrieve Candidate 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
Show inputSchema
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."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_candidate_reference_by_id
Retrieve Candidate Reference 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
referenceId | string | Yes | — | The unique ID of a candidate reference. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
},
"referenceId": {
"type": "string",
"description": "The unique ID of a candidate reference."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"referenceId"
]
}
ukg-recruiting-candidates_retrieve_candidates
Retrieve Candidates 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. |
candidate_type | string | No | — | The type of candidate to return. Valid values include internal, external, all. Defaults to all. |
role | string | No | — | The role of the returned candidates. Valid values include recruiter, hiring-manager, onboarding-owner, recruiting-administrator. |
Show inputSchema
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."
},
"candidate_type": {
"type": "string",
"description": "The type of candidate to return. Valid values include `internal`, `external`, `all`. Defaults to `all`."
},
"role": {
"type": "string",
"description": "The role of the returned candidates. Valid values include `recruiter`, `hiring-manager`, `onboarding-owner`, `recruiting-administrator`."
}
},
"required": [
"PCID",
"tenantalias"
]
}
ukg-recruiting-candidates_retrieve_comments_by_candidate_id
Retrieve Comments by Candidate ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | The customer tenant. Can be seen in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
candidateId | string | Yes | — | The unique ID of a candidate. |
Show inputSchema
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 seen in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_educations_by_candidate_id
Retrieve Educations by Candidate ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | Identifies the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
candidateId | string | Yes | — | The unique ID of a candidate. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "Identifies the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_licenses_by_candidate_id
Retrieve Licenses by Candidate ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantalias | string | Yes | — | An identifier for the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding. |
candidateId | string | Yes | — | A unique identifier for the candidate. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tenantalias": {
"type": "string",
"description": "An identifier for the customer tenant. Can be viewed in the browser bar when signed into UKG Pro Recruiting or UKG Pro Onboarding."
},
"candidateId": {
"type": "string",
"description": "A unique identifier for the candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_motivations_by_candidate_id
Retrieve Motivations by Candidate 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_name_and_email_by_candidate_id
Retrieve Name and Email 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. |
Show inputSchema
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."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_references_by_candidate_id
Retrieve References by Candidate 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_skills_by_candidate_id
Retrieve Skills by Candidate 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_retrieve_work_experiences_by_candidate_id
Retrieve Work Experiences by Candidate 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}
ukg-recruiting-candidates_update_assessment_by_id
Update Assessment 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. | |
candidateid | string | Yes | — | A unique identifier of the candidate. | |
assessmentid | string | Yes | — | A GUID provided by UKG after the provider’s integration is registered. Also provided in the POST assessment-link-request. | |
application | object | No | — | The application model. | |
assessment_integration | object | No | — | The assessment integration model. | |
assessment_results | object | No | — | The assessment results model. | |
assessment_url | string | null | No | — | The assessment URL. Maximum of 2000 chars. Must start with “https://” |
failure_status_description | string | null | No | — | The failure status description. Maximum of 100 characters. |
status | string | Yes | — | One of the values from the enumerated list: * Generating * NotStarted * InProgress * Abandoned * OptedOut * Completed * Deferred * Expired * Retrying * Failed * NotSent | |
status_changed_date | string | No | — | The timestamp of the last time the status changed. |
Show inputSchema
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."
},
"candidateid": {
"type": "string",
"description": "A unique identifier of the candidate."
},
"assessmentid": {
"type": "string",
"description": "A GUID provided by UKG after the provider's integration is registered. Also provided in the POST assessment-link-request."
},
"application": {
"type": "object",
"description": "The application model.",
"properties": {
"id": {
"type": "string",
"description": "The application ID provided in the POST assessment-link-request."
}
},
"required": [
"id"
]
},
"assessment_integration": {
"type": "object",
"description": "The assessment integration model.",
"properties": {
"id": {
"type": "string",
"description": "The assessment integration ID provided by UKG after the provider's integration is registered. Also provided in the POST assessment-link-request."
}
},
"required": [
"id"
]
},
"assessment_results": {
"type": "object",
"description": "The assessment results model.",
"properties": {
"assessment_results_url": {
"type": "string",
"description": "The assessment results URL. Maximum of 2000 characters. Must start with “https://” This link will be used by Recruiters to access the assessment report page in the provider's system."
},
"credit_amount": {
"type": "number",
"description": "A numeric with max 2 decimals. This field is used to specify the WOTC tax credit amount."
},
"is_passed": {
"type": "boolean",
"description": "This field can be used for WOTC eligibility status: True — eligible False — ineligible"
},
"metadata": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of field_name/field value pairs. Max 20 fields are supported."
},
"partner_confirmation_number": {
"type": "string",
"description": "The partner confirmation number. Maximum of 100 characters."
},
"partner_order_number": {
"type": "string",
"description": "The partner order number. Maximum of 100 characters."
},
"results_description": {
"type": "object",
"description": "The results description model."
},
"score": {
"type": "string",
"description": "An integer indicating the score. 0 through 100. Decimals are not supported."
}
}
},
"assessment_url": {
"type": [
"string",
"null"
],
"description": "The assessment URL. Maximum of 2000 chars. Must start with \"https://”"
},
"failure_status_description": {
"type": [
"string",
"null"
],
"description": "The failure status description. Maximum of 100 characters."
},
"status": {
"type": "string",
"description": "One of the values from the enumerated list: * Generating * NotStarted * InProgress * Abandoned * OptedOut * Completed * Deferred * Expired * Retrying * Failed * NotSent"
},
"status_changed_date": {
"type": "string",
"description": "The timestamp of the last time the status changed."
}
},
"required": [
"PCID",
"tenantalias",
"candidateid",
"assessmentid",
"status"
]
}
ukg-recruiting-candidates_update_background_check
Update Background Check 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. |
backgroundCheckId | string | Yes | — | The unique ID of a background check. |
application | object | Yes | — | The application value |
author | object | Yes | — | The author value |
background_check_integration | object | No | — | Background Check Integration |
order_number | string | Yes | — | The background check order number. Maximum of 100 characters. |
packages | object[] | Yes | — | An array of background check packages; at most 100. |
status | string | Yes | — | The status of the background check order. |
Show inputSchema
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."
},
"backgroundCheckId": {
"type": "string",
"description": "The unique ID of a background check."
},
"application": {
"type": "object",
"description": "The application value",
"properties": {
"id": {
"type": "string",
"description": "The id of the corresponding application."
}
},
"required": [
"id"
]
},
"author": {
"type": "object",
"description": "The author value",
"properties": {
"id": {
"type": "string",
"description": "The recruiter who created the order."
}
},
"required": [
"id"
]
},
"background_check_integration": {
"type": "object",
"description": "Background Check Integration",
"properties": {
"id": {
"type": "string",
"description": "The ids of the third party job board integration associated with the order. Must be provided for Partner integration (otherwise, will be defaulted to our current background check vendor)"
}
}
},
"order_number": {
"type": "string",
"description": "The background check order number. Maximum of 100 characters."
},
"packages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the package."
},
"name": {
"type": "object",
"description": "The name of the package in all available languages. Maximum of 100 characters"
},
"screenings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the screening."
},
"name": {
"type": "object",
"description": "The name of the background check screening in all available languages. Maximum of 100 characters."
}
}
},
"description": "An array of background check screenings; at most 100."
}
},
"required": [
"name"
]
},
"description": "An array of background check packages; at most 100."
},
"status": {
"type": "string",
"description": "The status of the background check order."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"backgroundCheckId",
"application",
"author",
"order_number",
"packages",
"status"
]
}
ukg-recruiting-candidates_update_candidate_reference_by_id
Update Candidate Reference 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. | |
candidateId | string | Yes | — | The unique ID of a candidate. | |
referenceId | string | Yes | — | The unique ID of a candidate reference. | |
company | string | null | No | — | The reference person’s company. Maximum of 50 characters. |
contact_info | object | No | — | The contact information model. | |
job_title | string | null | No | — | The reference person’s job title. Maximum of 50 characters. |
name | object | No | — | The name model. | |
recommendation | object | No | — | The recommendation model. | |
relationship | string | null | No | — | Accepted values: Personal/Professional. Non sensitive. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
},
"referenceId": {
"type": "string",
"description": "The unique ID of a candidate reference."
},
"company": {
"type": [
"string",
"null"
],
"description": "The reference person's company. Maximum of 50 characters."
},
"contact_info": {
"type": "object",
"description": "The contact information model.",
"properties": {
"email": {
"type": "string",
"description": "The reference person's e-mail. Maximum of 254 character."
},
"phone": {
"type": "string",
"description": "The reference person's phone number. Maximum of 20 characters."
}
}
},
"job_title": {
"type": [
"string",
"null"
],
"description": "The reference person's job title. Maximum of 50 characters."
},
"name": {
"type": "object",
"description": "The name model.",
"properties": {
"first": {
"type": "string",
"description": "The reference peson's first name. Maximum of 100 characters."
},
"former": {
"type": "string",
"description": "The reference peson's former name. Maximum of 100 characters."
},
"middle": {
"type": "string",
"description": "The reference person's middle name. Maximum of 50 characters."
},
"last": {
"type": "string",
"description": "The reference peson's last name. Maximum of 100 characters."
},
"prefix": {
"type": "object",
"description": "The prefix model."
},
"suffix": {
"type": "object",
"description": "The suffix model."
}
},
"required": [
"first",
"last"
]
},
"recommendation": {
"type": "object",
"description": "The recommendation model.",
"properties": {
"requested_at": {
"type": "string",
"description": "The date and time of the request. Defaults to UtcNow if null and recommended text is not empty."
},
"recommended_at": {
"type": "string",
"description": "The date and time of the recommendation. Defaults to UtcNow if null and recommended text is not empty."
},
"text": {
"type": "string",
"description": "The text of the recomendation. Required only if a recomended date is provided."
}
},
"required": [
"text"
]
},
"relationship": {
"type": [
"string",
"null"
],
"description": "Accepted values: Personal/Professional. Non sensitive."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId",
"referenceId"
]
}
ukg-recruiting-candidates_upload_documentby_candidate_id
Upload Document by Candidate 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. |
candidateId | string | Yes | — | The unique ID of a candidate. |
file | string | No | — | The candidate’s document. |
metadata | string | No | — | The metadata for the document. |
Show inputSchema
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."
},
"candidateId": {
"type": "string",
"description": "The unique ID of a candidate."
},
"file": {
"type": "string",
"description": "The candidate's document."
},
"metadata": {
"type": "string",
"description": "The metadata for the document."
}
},
"required": [
"PCID",
"tenantalias",
"candidateId"
]
}

