Recruitee | Composio Docs

Overview

SLUG: RECRUITEE

Description

Recruitee is a collaborative hiring software that streamlines recruitment processes, enabling teams to source, interview, and hire candidates efficiently.

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

string

subdomain

stringRequired

API Key

subdomain

stringRequired

generic_api_key

stringRequired

Connecting to Recruitee

Create an auth config

Use the dashboard to create an auth config for the Recruitee toolkit. This allows you to connect multiple Recruitee accounts to Composio for agents to use.

Select App

Navigate to Recruitee.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Recruitee Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1 from composio import Composio
2 
3 # Replace these with your actual values
4 recruitee_auth_config_id = "ac_YOUR_RECRUITEE_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/application
6 
7 composio = Composio()
8 
9 
10 def authenticate_toolkit(user_id: str, auth_config_id: str):
11     connection_request = composio.connected_accounts.initiate(
12         user_id=user_id,
13         auth_config_id=auth_config_id,
14     )
15 
16     print(
17         f"Visit this URL to authenticate Recruitee: {connection_request.redirect_url}"
18     )
19 
20     # This will wait for the auth flow to be completed
21     connection_request.wait_for_connection(timeout=15)
22     return connection_request.id
23 
24 
25 connection_id = authenticate_toolkit(user_id, recruitee_auth_config_id)
26 
27 # You can also verify the connection status using:
28 connected_account = composio.connected_accounts.get(connection_id)
29 print(f"Connected account: {connected_account}")

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 recruitee_auth_config_id = "ac_YOUR_RECRUITEE_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Recruitee for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, recruitee_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Recruitee toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

RECRUITEE_CREATE_CANDIDATE

Tool Name: Create Candidate

Description

Tool to create a new candidate profile. Use after gathering all candidate details. Example: "Create a new candidate named Jane Doe with email jane.doe@example.com."

Action Parameters

cover_letter

custom_fields

name

stringRequired

offers

phone

photo

resume

social_links

source

RECRUITEE_CREATE_NOTE

Tool Name: Create Note

Description

Tool to create a new note for a candidate. Use after confirming this detail.

Action Parameters

candidate_id

stringRequired

note

objectRequired

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_CREATE_OFFER

Tool Name: Create Offer

Description

Tool to create a new job offer. Use after confirming all offer details and ready to publish.

Action Parameters

offer

objectRequired

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_DELETE_CANDIDATE

Tool Name: Delete Candidate

Description

Tool to delete a candidate profile. Use when you need to permanently remove a candidate from your Recruitee account. Returns no content on success.

Action Parameters

candidate_id

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_DELETE_TAG

Tool Name: Delete Tag

Description

Tool to delete a tag. Use when you need to permanently remove a tag from Recruitee. Use after confirming the tag is not in use.

Action Parameters

tag_id

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_CANDIDATE

Tool Name: Get Candidate

Description

Tool to retrieve detailed information about a specific candidate. Use when you need the candidate's full profile before proceeding.

Action Parameters

candidate_id

integerRequired

company_id

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_CANDIDATES

Tool Name: Get Candidates

Description

Tool to retrieve a list of all candidates in the company. Use when you need to fetch or filter candidates before proceeding.

Action Parameters

company_id

createdAfter

deleted

disqualified

ids

limit

offerId

offset

qualified

query

sort

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_COMPANY_ID

Tool Name: Get Company ID

Description

Tool to retrieve the company ID of the authenticated account. Use when you need to confirm your company identity before other operations.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_COMPANY_OFFER_PUBLIC

Tool Name: Get Company Offer Public

Description

Tool to retrieve a specific published job offer by ID or slug from the public Careers Site API. Use after you have the offer identifier.

Action Parameters

identifier

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_COMPANY_OFFERS_PUBLIC

Tool Name: Get Company Offers Public

Description

Tool to get a list of published company jobs from the Careers Site API. Use when you need to list all current published offers.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_DEPARTMENTS

Tool Name: Get Departments

Description

Tool to retrieve a list of company departments. Use when you need to reference or assign offers or candidates to departments.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_LOCATIONS

Tool Name: Get Locations

Description

Tool to retrieve a list of company locations. Use when you need to see all location options before assigning them to offers.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_NOTES

Tool Name: Get Notes

Description

Tool to retrieve a list of notes for a specific candidate. Use after confirming the candidate exists when you need to review their notes.

Action Parameters

candidate_id

integerRequired

limit

offset

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_OFFER

Tool Name: Get Offer

Description

Tool to retrieve detailed information about a specific job offer. Use when you have the offer ID and need its full metadata.

Action Parameters

offer_id

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_OFFERS

Tool Name: Get Offers

Description

Tool to retrieve a list of all job offers. Use after authentication to browse or paginate your company's complete set of offers.

Action Parameters

company_id

limit

offset

query

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_PIPELINE_STAGES

Tool Name: Get Pipeline Stages

Description

Tool to retrieve pipeline stages of a job offer. Use when you have the offer ID and need its stages to track candidate progression. Example: "Get pipeline stages for offer ID 456."

Action Parameters

offer_id

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_GET_TAGS

Tool Name: Get Tags

Description

Tool to retrieve a list of all tags. Use after authenticating to fetch or search tags by name or usage count.

Action Parameters

page

per_page

query

sort_by

sort_order

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_UPDATE_CANDIDATE

Tool Name: Update Candidate

Description

Tool to update information for an existing candidate. Use when you need to modify a candidate's profile after retrieval.

Action Parameters

candidate_id

integerRequired

cover_letter

custom_fields

name

offers

phone

photo

resume

social_links

source

RECRUITEE_UPDATE_NOTE

Tool Name: Update Note

Description

Tool to update an existing note for a candidate. Use when you need to modify note text or pin status after creation.

Action Parameters

body

candidate_id

integerRequired

note_id

integerRequired

pinned

Action Response

data

objectRequired

error

successful

booleanRequired

RECRUITEE_UPDATE_OFFER

Tool Name: Update Offer

Description

Tool to update information for an existing job offer. Use when you need to modify an offer's details after retrieval.

Action Parameters

offer_id

integerRequired

options_cover_letter

options_cv

options_phone

options_photo

Action Response

data

objectRequired

error

successful

booleanRequired