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

# Recruiterflow

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

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

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

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

ATS
CRM

## 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 Key · Connector Profile](https://docs.stackone.com/connectors/recruiterflow/guides/connector-profile/api-key.md)
>
> Recruiterflow uses an API key sent in the RF-Api-Key header. API keys are issued by the Recruiterflow team — they are no...

**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 Key · Link Account](https://docs.stackone.com/connectors/recruiterflow/guides/link-account/api-key.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

49 actions

ActionDescription

This Endpoint Lists All Campaigns Created Within Recruiterflow`recruiterflow_list_campaigns`

This endpoint lists all campaigns created within Recruiterflow

Add A Candidate Record.`recruiterflow_create_candidate`

Add a candidate record.

Add A Candidate To A Job, Candidates Will Show Up Under The Sourced Stage`recruiterflow_post_candidate_add_to_job`

Add a candidate to a job, candidates will show up under the Sourced stage

Disqualify A Candidate With A Reason.`recruiterflow_post_candidate_disqualify`

Disqualify a candidate with a reason.

Fields Are The Same As The Candidate List API Above.`recruiterflow_get_candidate`

Fields are the same as the candidate list API above.

Get Details Of A Particular Candidate Record`recruiterflow_list_candidates`

Get details of a particular candidate record

Move A Candidate To A Stage In A Job`recruiterflow_post_candidate_move_to_stage`

Move a candidate to a stage in a job

The Endpoint Adds Notes To The Specified Candidate.`recruiterflow_create_candidate_notes`

The endpoint adds notes to the specified candidate.

This API Returns Scorecard Details Specified.`recruiterflow_get_candidate_scorecard`

This API returns scorecard details specified.

Get All Scorecards For A Candidate And Job\_id`recruiterflow_list_candidate_scorecard`

Get all scorecards for a candidate and job\_id

Find All Search Types In The Link Below.`recruiterflow_search_candidates`

Find all search types in the link below.

This API Implements A Complete Update Which Means That Any Existing Data In The Provided Key Will Be Wiped Out And Replaced With The Data Provided, In Case A Key Is Not Provided No Update Happens To It.`recruiterflow_update_candidate`

This API implements a complete update which means that any existing data in the provided key will be wiped out and repla...

This Endpoint Is Used To Add Client Company.`recruiterflow_create_client`

This endpoint is used to add client company.

Get Client Company Details For The Specified Client.`recruiterflow_get_client`

Get client company details for the specified client.

Lists All Client Company In The Account.`recruiterflow_list_clients`

Lists all client company in the account.

Adds Note To The Specified Client Company`recruiterflow_create_client_notes`

Adds note to the specified client company

Find All Search Types In The Link Below.`recruiterflow_search_clients`

Find all search types in the link below.

Updates Existing Client Company Details, Including Custom Fields`recruiterflow_update_client`

Updates existing client company details, including custom fields

The Contact Endpoint Allows You To Add A Contact To Recruiterflow.`recruiterflow_create_contact`

The contact endpoint allows you to add a contact to Recruiterflow.

Returns The Contacts Info For The Specified Id.`recruiterflow_get_contact`

Returns the contacts info for the specified id.

Lists All Contacts And Their Details.`recruiterflow_list_contacts`

Lists all contacts and their details.

The Endpoint Adds Notes To The Specified Contact.`recruiterflow_create_contact_notes`

The endpoint adds notes to the specified contact.

Find All Search Types In The Link Below.`recruiterflow_search_contacts`

Find all search types in the link below.

This API Implements A Complete Update Which Means That Any Existing Data In The Provided Key Will Be Wiped Out And Replaced With The Data Provided, In Case A Key Is Not Provided No Update Happens To It.`recruiterflow_update_contact`

This API implements a complete update which means that any existing data in the provided key will be wiped out and repla...

Get List Of Deals`recruiterflow_list_deals`

Get a paginated list of all deals in Recruiterflow.

Create A New Deal.`recruiterflow_create_deal`

Create a New Deal.

Get Details Of A Particular Deal.`recruiterflow_get_deal`

Get details of a particular deal.

Move A Deal To A New Stage`recruiterflow_post_deal_move_stage`

Move a deal to a new stage

Find All Search Types In The Link Below.`recruiterflow_search_deals`

Find all search types in the link below.

Update The Deal.`recruiterflow_update_deal`

Update the Deal.

The Jobs Endpoint Allows You To Export All Jobs-related Information From Recruiterflow.`recruiterflow_get_job`

The jobs endpoint allows you to export all jobs-related information from Recruiterflow.

Close A Job In Recruiterflow`recruiterflow_post_job_close`

Close a job in Recruiterflow

Create A New Job.`recruiterflow_create_job`

Create a new job.

Lists All Job Departments.`recruiterflow_list_job_department`

Lists all job departments.

Lists All Jobs In The Account.`recruiterflow_list_jobs`

Lists all jobs in the account.

Adds Note To The Specified Job Record.`recruiterflow_create_job_notes`

Adds note to the specified job record.

Open A Job In Recruiterflow`recruiterflow_post_job_open`

Open a job in Recruiterflow

Returns Detailed Information About A Job's Pipeline`recruiterflow_get_job_pipeline`

Returns detailed information about a job's pipeline

Searches Job With A Specific Filter Or Query`recruiterflow_search_jobs`

Searches job with a specific filter or query

External API For Job Update`recruiterflow_update_job`

External API for Job Update

Lists All Job Locations In The Account.`recruiterflow_list_locations`

Lists all job locations in the account.

List All Tags For Candidates And Contacts.`recruiterflow_list_tags`

List all tags for candidates and contacts.

Lists All Placements For Specified Job.`recruiterflow_list_job_placement_record`

Lists all placements for specified job.

Create A Placement.`recruiterflow_create_placement_record`

Create a placement.

Returns The Placement Info For Specified Placement Record.`recruiterflow_get_placement_record`

Returns the placement info for specified placement record.

Lists All Placements In The Account.`recruiterflow_list_placement_records`

Lists all placements in the account.

Update A Placement.`recruiterflow_update_placement_record`

Update a placement.

The User Get Endpoint Allows You To Search For A Specific User Based On Email/id`recruiterflow_get_user`

The User get endpoint allows you to search for a specific user based on email/id

The Users Endpoint Allows You To Export All User Related Information From Recruiterflow.`recruiterflow_list_users`

The Users endpoint allows you to export all user related information from Recruiterflow.


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