> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Phenom

> How to set up the Phenom connector, plus the actions that are available.

![Phenom](https://stackone-logos.com/api/phenom/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/phenom/changelog.md)

[87 actions](#actions) · 1 auth method

ATS
HRIS
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/phenom/guides/connector-profile/oauth-2-0.md)
>
> Requires OAuth2 client credentials provisioned by Phenom. Contact [api-management@phenom.com](mailto:api-management@phenom.com) to request API access and ob...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/phenom/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

87 actions

ActionDescription

Get Job FitScore`phenom_get_job_fitscore`

Calculate AI-based FitScore for a candidate profile against one or more job IDs.

Get Matching Skills`phenom_get_matching_skills`

Retrieve matching and unmatching skills between a candidate and a specific job.

List Applicants By Job`phenom_list_applicants_by_job`

Retrieve a paginated list of applicants for a specific job.

Get Candidate Applications`phenom_get_candidate_applications`

Retrieve all job applications for a specific candidate.

Get Hiring Status`phenom_get_hiring_status`

Get the current hiring status for a candidate's application to a specific job.

Get Next Hiring Status`phenom_get_next_hiring_status`

Get available next hiring status transitions for a candidate's application.

Update Hiring Status`phenom_update_hiring_status`

Update the hiring status for a candidate's application to a specific job.

Get Hiring Status Activities`phenom_get_hiring_status_activities`

Retrieve the full hiring status activity history for a candidate across all jobs.

Assign Candidates To Job`phenom_assign_candidates_to_job`

Assign one or more candidates to a job as leads or applicants.

Get Candidate Leads`phenom_get_candidate_leads`

Retrieve lead activity history for a candidate.

Get Application Attachments`phenom_get_application_attachments`

Retrieve attachments for a candidate's job application.

Get Application Additional Fields`phenom_get_application_additional_fields`

Retrieve job-specific additional fields for a candidate's application.

Update Application Additional Fields`phenom_update_application_additional_fields`

Update job-specific additional fields for a candidate's application.

List Applications`phenom_list_applications`

Retrieve a paginated list of job applications from Phenom.

Get Application`phenom_get_application`

Retrieve a specific job application by ID.

Submit Application`phenom_submit_application`

Submit a new job application on behalf of a candidate.

Check Already Applied`phenom_check_already_applied`

Check if a candidate has already applied to a specific job.

Download Application Attachments`phenom_download_application_attachments`

Download attachments (resumes) for a specific application.

Upload Application Attachments`phenom_upload_application_attachments`

Upload an attachment to an existing job application.

Get Candidate`phenom_get_candidate`

Retrieve a candidate profile by ID, email, ATS ID, or LinkedIn URL.

Create Candidate`phenom_create_candidate`

Create a new candidate profile in Phenom.

Update Candidate`phenom_update_candidate`

Update an existing candidate profile in Phenom.

Delete Candidate`phenom_delete_candidate`

Delete a candidate record from Phenom by candidate ID.

Get Candidate Experiences`phenom_get_candidate_experiences`

Retrieve work experience history for a specific candidate.

Update Candidate Experiences`phenom_update_candidate_experiences`

Update work experience history for a candidate using replace or merge strategy.

Get Candidate Educations`phenom_get_candidate_educations`

Retrieve education history for a specific candidate.

Update Candidate Educations`phenom_update_candidate_educations`

Update education history for a candidate using replace or merge strategy.

Get Candidate Skills`phenom_get_candidate_skills`

Retrieve the skills list for a specific candidate.

Update Candidate Skills`phenom_update_candidate_skills`

Update the skills list for a candidate using replace or merge strategy.

Get Candidate Awards`phenom_get_candidate_awards`

Retrieve awards for a specific candidate.

Update Candidate Awards`phenom_update_candidate_awards`

Update the awards list for a candidate using replace or merge strategy.

Get Candidate Certifications`phenom_get_candidate_certifications`

Retrieve certifications for a specific candidate.

Update Candidate Certifications`phenom_update_candidate_certifications`

Update certifications for a candidate using replace or merge strategy.

Get Candidate Preferred Locations`phenom_get_candidate_preferred_locations`

Retrieve preferred work locations for a specific candidate.

Update Candidate Preferred Locations`phenom_update_candidate_preferred_locations`

Update preferred work locations for a candidate using add, remove, or replace strategy.

Get Candidate Address`phenom_get_candidate_address`

Retrieve address information for a specific candidate.

Update Candidate Address`phenom_update_candidate_address`

Update address information for a candidate.

Get Candidate Recommendations`phenom_get_candidate_recommendations`

Retrieve professional recommendations for a specific candidate.

Update Candidate Recommendations`phenom_update_candidate_recommendations`

Update professional recommendations for a candidate.

Get Candidate Additional Fields`phenom_get_candidate_additional_fields`

Retrieve tenant-specific custom additional fields for a candidate.

Update Candidate Additional Fields`phenom_update_candidate_additional_fields`

Update tenant-specific custom additional fields for a candidate.

Send Email`phenom_send_email`

Send a transactional email to a candidate.

Send SMS`phenom_send_sms`

Send a transactional SMS message to a candidate.

Get SMS Opt-In Status`phenom_get_sms_optin_status`

Check the SMS opt-in status for a candidate by email or phone number.

Update SMS Opt-In Status`phenom_update_sms_optin_status`

Update the SMS opt-in status for a candidate.

Create Employee`phenom_create_employee`

Create a new employee profile in Phenom.

Get Employee`phenom_get_employee`

Retrieve an employee profile by employee ID.

Update Employee`phenom_update_employee`

Update an employee profile in Phenom.

Delete Employee`phenom_delete_employee`

Delete an employee profile from Phenom.

Get Employee Preferences`phenom_get_employee_preferences`

Retrieve job preferences for a specific employee.

Create Employee Preferences`phenom_create_employee_preferences`

Create job preferences for an employee (interests and preferred locations).

Update Employee Preferences`phenom_update_employee_preferences`

Update job preferences for an employee.

Delete Employee Preferences`phenom_delete_employee_preferences`

Delete job preferences for an employee.

Get Employee Career Path`phenom_get_employee_career_path`

Retrieve the career path for an employee.

Create Employee Career Path`phenom_create_employee_career_path`

Create a career path for an employee.

Update Employee Career Path`phenom_update_employee_career_path`

Update the career path for an employee.

Create Course`phenom_create_course`

Create a new learning course in Phenom.

Get Course`phenom_get_course`

Retrieve a learning course by ID.

Update Course`phenom_update_course`

Update a learning course in Phenom.

Delete Course`phenom_delete_course`

Delete a learning course from Phenom.

Get Employee Courses`phenom_get_employee_courses`

Retrieve all courses assigned to an employee.

Assign Course To Employee`phenom_assign_course_to_employee`

Assign a learning course to an employee.

Remove Course From Employee`phenom_remove_course_from_employee`

Remove a course assignment from an employee.

Update Employee Course Status`phenom_update_employee_course_status`

Update the completion status of a course for an employee.

Get Employee Completed Courses`phenom_get_employee_completed_courses`

Retrieve the list of completed courses for an employee.

Create Referral`phenom_create_referral`

Submit an employee job referral for a candidate.

Get Employee Referrals`phenom_get_employee_referrals`

Retrieve all referrals submitted by an employee.

Get Employee Job Recommendations`phenom_get_employee_job_recommendations`

Retrieve recommended jobs an employee can refer candidates to.

Get Referral Questionnaire`phenom_get_referral_questionnaire`

Retrieve the current referral questionnaire configuration.

Get Job Recommendations By Resume`phenom_get_job_recommendations_by_resume`

Get job recommendations for referrals by uploading a resume file.

Create Referral Questionnaire`phenom_create_referral_questionnaire`

Create or update the referral questionnaire configuration.

List Jobs`phenom_list_jobs`

Retrieve a list of jobs from Phenom with optional filtering by job ID, locale, category, or site type.

Get Job`phenom_get_job`

Retrieve a specific job posting by its reference ID from Phenom.

Create Job`phenom_create_job`

Create a new job posting in the Phenom database.

Update Job`phenom_update_job`

Update an existing job posting by reference ID using partial update (PATCH).

Delete Job`phenom_delete_job`

Delete a job posting from Phenom by its reference ID.

Parse Resume (Base64)`phenom_parse_resume_base64`

Parse a resume from base64-encoded file content to extract structured candidate data.

Parse Resume (File Upload)`phenom_parse_resume_file`

Parse a resume from a direct file upload to extract structured candidate data.

Search Users`phenom_search_users`

Search for Phenom platform users with filtering, sorting, and pagination.

List Users (SCIM)`phenom_list_users_scim`

List all platform users via SCIM 2.0 protocol.

Create User (SCIM)`phenom_create_user_scim`

Create a new platform user via SCIM 2.0 protocol.

Get User (SCIM)`phenom_get_user_scim`

Retrieve a platform user by ID via SCIM 2.0 protocol.

Update User (SCIM)`phenom_update_user_scim`

Replace a platform user via SCIM 2.0 protocol (full replacement).

Patch User (SCIM)`phenom_patch_user_scim`

Partially update a platform user via SCIM 2.0 protocol.

Delete User (SCIM)`phenom_delete_user_scim`

Delete a platform user via SCIM 2.0 protocol.

List Groups (SCIM)`phenom_list_groups_scim`

List all user groups via SCIM 2.0 protocol.

List Roles (SCIM)`phenom_list_roles_scim`

List all user roles via SCIM 2.0 protocol.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.