> ## 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.

# RECRU

> How to set up the RECRU connector, plus the actions and events that are available.

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

v2.0.2[See changelog](https://docs.stackone.com/connectors/recru/changelog.md)

[66 actions](#actions) · [2 events](#events) · 1 auth method

ATS

## 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] [API Credentials · Connector Profile](https://docs.stackone.com/connectors/recru/guides/connector-profile/api-credentials.md)
>
> Uses the tenant-wide \`api\` user and its API password.

Optionally, configure receiving Events for RECRU into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/recru/guides/webhook-setup.md)

**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] [API Credentials · Link Account](https://docs.stackone.com/connectors/recru/guides/link-account/api-credentials.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

66 actions

ActionDescription

Add Candidate Education`recru_create_candidate_education`

Add Candidate Education

Add Candidate Preferred Work Locations`recru_create_candidate_preferred_work_locations`

Add Candidate Preferred Work Locations

Add Candidate Work Position`recru_create_candidate_work_position`

Add Candidate Work Position

Delete Candidate Education`recru_delete_candidate_education`

Delete Candidate Education

Delete Candidate Preferred Work Locations`recru_delete_candidate_preferred_work_locations`

Delete Candidate Preferred Work Locations

Delete Candidate Work Position`recru_delete_candidate_work_position`

Delete Candidate Work Position

List Candidate Educations`recru_list_candidate_educations`

List Candidate Educations

List Candidate Preferred Locations`recru_list_candidate_preferred_locations`

List Candidate Preferred Locations

List Candidate Work Positions`recru_list_candidate_work_positions`

List Candidate Work Positions

Update Candidate Education`recru_update_candidate_education`

Update Candidate Education

Update Candidate Work Position`recru_update_candidate_work_position`

Update Candidate Work Position

Delete Candidate Event`recru_delete_candidate_event`

Delete Candidate Event

Get Candidate`recru_get_candidate`

Detailed information about candidate

Get Candidate CV File Content`recru_get_candidate_cv_content`

returns base64 encoded file content

Get Candidate File Content`recru_get_candidate_file_content`

returns base64 encoded file content

Get Candidate Test Result Detail`recru_get_candidate_test_result_detail`

Get Candidate Test Result Detail

List Candidate Events`recru_list_candidate_events`

List of all candidate events

List Candidate Files`recru_list_candidate_files`

List of files with paging and search

List Candidate Test Results`recru_list_candidate_tests_results`

List Candidate Test Results

List Candidates`recru_list_candidates`

List of candidates with paging and search. Search uses only the basic Candidate entity fields (does not search in tags o...

List Candidates (id + Name Only)`recru_list_candidates_simple`

Simple list of candidates contains only basic information about the candidate. Use it to increase speed when you don't n...

Remove Tags From Candidate`recru_remove_candidate_tags`

Remove Tags From Candidate

Create Or Update Candidate (upsert)`recru_update_candidate`

Save a new candidate or update existing candidate data (upsert)

Set Candidate Color Marker`recru_update_candidate_color`

Set Candidate Color Marker

Create Or Update Candidate Event`recru_update_candidate_event`

Create or Update Candidate Event

Add Tags To Candidate`recru_update_candidate_tags`

Add Tags To Candidate

List Candidate Source Channels`recru_list_candidate_sources`

List Candidate Source Channels

List Available Colors`recru_list_colors`

List Available Colors

List Country Code/Name Pairs`recru_list_country_pairs`

List Country Code/Name Pairs

List Locales`recru_list_locales`

List Locales

List Event Types`recru_list_event_types`

List Event Types

List Rejection Reasons`recru_list_rejection_reasons`

List Rejection Reasons

List Project Close Reasons`recru_list_project_close_reasons`

List Project Close Reasons

Ping RECRU`recru_ping_recru`

Verifies the connection to RECRU by calling ToolsService.ping. Returns the server's view of the current time, the caller...

Get Department Contact`recru_get_department_contact`

Return contact of department based on ID

List Department Contacts`recru_list_department_contacts`

List of Department Contacts

Create Or Update Department Contact (upsert)`recru_update_department_contact`

save new department contact or update existing department contact

Get Department (Client)`recru_get_department`

Return department based on ID

Get Department File Content`recru_get_department_file_content`

returns base64 encoded file content

List Department Files`recru_list_department_files`

List of files with paging and search

List Departments`recru_list_departments`

List of departments with paging and search

List Departments (id + Name Only)`recru_list_departments_simple`

List of departments with paging and search

Create Or Update Department (upsert)`recru_update_department`

save new department or update existing department data

Set Department Color Marker`recru_update_department_color`

Set Department Color Marker

Get Job Offer`recru_get_offer`

Return job offer based on ID

List Job Offers`recru_list_offers`

List of job offers with paging and search in basic job offer fields

Create Or Update Company Website Offer`recru_update_company_website_offer`

Save Job Offer Data on Company Website

Add Candidate To Project (application)`recru_create_project_candidate`

Add Candidate to Project (application)

Add Phase Event To Project Candidate`recru_create_project_candidate_phase_event`

Add Phase Event To Project Candidate

Remove Candidate From Project`recru_delete_project_candidate`

Remove Candidate From Project

Delete Project Candidate Phase Event`recru_delete_project_candidate_phase_event`

Delete Project Candidate Phase Event

Get Candidate Project Progress (phase History)`recru_get_project_candidate_progress`

Candidate's project stage

List Candidates On Project`recru_list_project_candidates`

List of candidates with paging and search

Update Project Candidate Phase Event`recru_update_project_candidate_phase_event`

Update Project Candidate Phase Event

Get Project (Job Opening)`recru_get_project`

Return project based on ID

Get Project Offer Reaction Form URL`recru_get_project_offer_reaction_form_url`

Get URL to Job Offer Application Form

List Project Phases (pipeline Stages)`recru_list_project_phases`

List Project Phases (pipeline stages)

List Projects`recru_list_projects`

List of projects with paging and search. Search uses only the basic project fields (does not search candidates)

List Projects (id + Name Only)`recru_list_projects_simple`

Simple list of projects contains only basic information about the project. Use it to increase speed when you don't need...

Create Or Update Project (upsert)`recru_update_project`

save a new project or update existing project data

List Tag Sectors`recru_list_tag_sectors`

List of sectors with paging and search

List Tag Seniority Levels`recru_list_tag_seniorities`

List of seniorities with paging and search

List Tags`recru_list_tags`

List of tags with paging and search

Get User`recru_get_user`

Get User

List Allowed Mobile App Menu Items For User`recru_list_user_mobile_app_menu_items`

List Allowed Mobile App Menu Items for User

List Users`recru_list_users`

List of users with paging and search

## Events

Tags

Select all
|
Clear

Offers

Webhooks

No tags found

2 events

EventDescriptionTags

Job Offer Published`recru_webhook_offer_published`

Processes RECRU offer publication events.

OffersWebhooks

Job Offer Unpublished`recru_webhook_offer_unpublished`

Processes RECRU offer unpublication events.

OffersWebhooks


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