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

# Recruit CRM

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

![Recruit CRM](https://stackone-logos.com/api/recruitcrm/filled/svg)

Betav0.2.1[See changelog](https://docs.stackone.com/connectors/recruitcrm/changelog.md)

[83 actions](#actions) · 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 Key · Connector Profile](https://docs.stackone.com/connectors/recruitcrm/guides/connector-profile/api-key.md)
>
> Uses a static API token sent as a Bearer token. Only the account owner can generate the token, and a Business plan or hi...

**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/recruitcrm/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

83 actions

ActionDescription

List Candidates`recruitcrm_list_candidates`

Returns all candidates associated with your account.

Get Candidate`recruitcrm_get_candidate`

Returns a single candidate

Create Candidate`recruitcrm_create_candidate`

Creates a new Candidate.(Use Content-Type : Multipart/form-data if you want to upload any file)

Update Candidate`recruitcrm_update_candidate`

Edit a candidate.

Delete Candidate`recruitcrm_delete_candidate`

Delete a candidate.

Search Candidates`recruitcrm_search_candidates`

Returns all candidates associated with your account that matched the search.(Enter at least one additional parameter apa...

Assign Candidate To Job`recruitcrm_assign_candidate_to_job`

Assign a candidate to a job.

Unassign Candidate From Job`recruitcrm_unassign_candidate_from_job`

Un-assign a candidate from the job.

Apply Candidate To Job`recruitcrm_apply_candidate_to_job`

Apply to a job.

List Candidate Hiring Stages`recruitcrm_list_candidate_hiring_stages`

Returns a list of hiring stages of a candidate.

Update Candidate Hiring Stage`recruitcrm_update_candidate_hiring_stage`

Update a candidate's hiring stage.

Get Candidate History`recruitcrm_get_candidate_history`

Returns hiring stage history of the candidate

Parse Resume`recruitcrm_parse_resume`

The Resume Parser API allows you to upload a resume (CV) and automatically create or update a candidate in Recruit CRM w\...

List Companies`recruitcrm_list_companies`

Returns all companies associated with your account.

Get Company`recruitcrm_get_company`

Returns a single company

Create Company`recruitcrm_create_company`

Creates a new company.

Update Company`recruitcrm_update_company`

Edit a company.

Delete Company`recruitcrm_delete_company`

Delete a company.

Search Companies`recruitcrm_search_companies`

Returns all companies associated with your account that matched the search.(Enter at least one additional parameter apar...

List Contacts`recruitcrm_list_contacts`

Returns all contacts associated with your account.

Get Contact`recruitcrm_get_contact`

Returns a single contact

Create Contact`recruitcrm_create_contact`

Creates a new contact.

Update Contact`recruitcrm_update_contact`

Edit a contact.

Delete Contact`recruitcrm_delete_contact`

Delete a contact.

Search Contacts`recruitcrm_search_contacts`

Returns all contacts associated with your account that matched the search.(Enter at least one additional parameter apart...

List All Custom Fields`recruitcrm_list_custom_fields`

Returns all custom fields associated with your account.

List Candidate Custom Fields`recruitcrm_list_candidate_custom_fields`

Returns all candidate custom fields associated with your account.

List Contact Custom Fields`recruitcrm_list_contact_custom_fields`

Returns all contact custom fields associated with your account.

List Company Custom Fields`recruitcrm_list_company_custom_fields`

Returns all company custom fields associated with your account.

List Job Custom Fields`recruitcrm_list_job_custom_fields`

Returns all job custom fields associated with your account.

List Deal Custom Fields`recruitcrm_list_deal_custom_fields`

Returns all deal custom fields associated with your account.

List Job Associated Custom Fields`recruitcrm_list_job_associated_custom_fields`

Returns all job associated custom fields associated with your account.

List Deals`recruitcrm_list_deals`

Returns all deals associated with your account.

Get Deal`recruitcrm_get_deal`

Returns a single deal

Create Deal`recruitcrm_create_deal`

Creates a new Deal.

Update Deal`recruitcrm_update_deal`

Edit a deal.

Delete Deal`recruitcrm_delete_deal`

Delete a deal.

Search Deals`recruitcrm_search_deals`

Returns all deals associated with your account that matched the search.(Enter at least one additional parameter apart fr...

List Hotlists`recruitcrm_list_hotlists`

Returns all hotlists associated with your account.

Get Hotlist`recruitcrm_get_hotlist`

Returns a single hotlist

Create Hotlist`recruitcrm_create_hotlist`

Creates a new Hotlist.

Update Hotlist`recruitcrm_update_hotlist`

Edit a hotlist.

Delete Hotlist`recruitcrm_delete_hotlist`

Delete a hotlist.

Add Records To Hotlist`recruitcrm_add_records_to_hotlist`

Adds records to Hotlist.

Remove Records From Hotlist`recruitcrm_remove_records_from_hotlist`

Removes records from Hotlist.

Search Hotlists`recruitcrm_search_hotlists`

Returns all hotlists associated with your account that matched the search.

List Jobs`recruitcrm_list_jobs`

Returns all jobs associated with your account.

Get Job`recruitcrm_get_job`

Returns a single job

Create Job`recruitcrm_create_job`

Creates a new Job.

Update Job`recruitcrm_update_job`

Edit a Job.

Delete Job`recruitcrm_delete_job`

Delete a Job.

Search Jobs`recruitcrm_search_jobs`

Returns all jobs associated with your account that matched the search.(Enter at least one additional parameter apart fro...

List Assigned Candidates For Job`recruitcrm_list_job_assigned_candidates`

Return list of assigned candidates for requested job

List Currencies`recruitcrm_list_currencies`

Returns a list of currencies

List Salary Types`recruitcrm_list_salary_types`

Returns a list of salary types

List Industries`recruitcrm_list_industries`

Returns a list of industries

List Languages`recruitcrm_list_languages`

Returns a list of languages

List Proficiencies`recruitcrm_list_proficiencies`

Returns a list of proficiencies

List Qualifications`recruitcrm_list_qualifications`

Returns a list of qualifications

List Task Types`recruitcrm_list_task_types`

Returns a list of Task types

List Note Types`recruitcrm_list_note_types`

Returns a list of note types

List Meeting Types`recruitcrm_list_meeting_types`

Returns a list of meeting types

List Call Types`recruitcrm_list_call_types`

Returns a list of call types

List Hiring Pipelines`recruitcrm_list_hiring_pipelines`

Returns a list of hiring pipelines

Get Hiring Pipeline Stages`recruitcrm_get_hiring_pipeline_stages`

Returns a list of hiring stages for the requested pipeline

List Job Pipeline Stages`recruitcrm_list_job_pipeline_stages`

Returns a list of stages in jobs pipeline

List Deal Pipeline Stages`recruitcrm_list_deal_pipeline_stages`

Returns a list of stages in deals pipeline

List Notes`recruitcrm_list_notes`

Returns all notes associated with your account.

Get Note`recruitcrm_get_note`

Returns a single note

Create Note`recruitcrm_create_note`

Creates a new Note.

Update Note`recruitcrm_update_note`

Edit a note.

Delete Note`recruitcrm_delete_note`

Delete a note.

Search Notes`recruitcrm_search_notes`

Returns all notes associated with your account that matched the search.

List Tasks`recruitcrm_list_tasks`

Returns all tasks associated with your account.

Get Task`recruitcrm_get_task`

Returns a single task

Create Task`recruitcrm_create_task`

Creates a new Task.

Update Task`recruitcrm_update_task`

Edit task.

Delete Task`recruitcrm_delete_task`

Delete a task.

Search Tasks`recruitcrm_search_tasks`

Returns all tasks associated with your account that matched the search.

List Users`recruitcrm_list_users`

Returns a list of users

Search Users`recruitcrm_search_users`

Returns all users associated with your account that matched the search.

List Teams`recruitcrm_list_teams`

Returns a list of teams

List Collaborators`recruitcrm_list_collaborators`

Returns a list of collaborators


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