Skip to main content
Recruitee logo
  • Category: hr talent & recruitment
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 23
  • Triggers: 0
  • Slug: RECRUITEE
  • Version: 20261101_00

Tools

Slug: RECRUITEE_CREATE_CANDIDATETool 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.”

Input Parameters

string
required
Full name of the candidate.
array
List of tags associated with the candidate.
string
Email address of the candidate
string
Phone number of the candidate.
string
URL to the candidate’s photo
array
List of offer IDs to associate with the candidate.
string
URL to the candidate’s resume
string
The source from which the candidate was obtained.
string
Cover letter text for the candidate.
List of social media profile links for the candidate.
object
Custom fields for the candidate as defined by the company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_CREATE_NOTECreates a new note for a candidate in Recruitee. Notes can be used to record interview feedback, assessments, or any observations about the candidate. Use this when you need to add commentary or documentation to a candidate’s profile.

Input Parameters

object
required
The note object containing content and optional visibility.
string
required
Unique identifier of the candidate to attach the note to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_CREATE_OFFERCreates a new job offer or talent pool in Recruitee. Required fields include title, location IDs, and description. Use Get Locations action to retrieve valid location IDs before creating an offer. The offer status can be set to draft, internal, published, closed, or archived.

Input Parameters

object
required
The offer object containing details for the new job offer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_DELETE_CANDIDATETool to delete a candidate profile. Use when you need to permanently remove a candidate from your Recruitee account. Returns no content on success.

Input Parameters

integer
required
Unique identifier of the candidate to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_DELETE_TAGPermanently deletes a tag from Recruitee by its ID. This action requires appropriate API permissions to delete tags. Use this when you need to remove unused or obsolete tags. Note: Deleting a tag removes it from all associated candidates and offers.

Input Parameters

integer
required
The unique numeric identifier of the tag to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_DISQUALIFY_PLACEMENTDisqualify a candidate placement using a configured reason.

Input Parameters

integer
required
Unique ID of the candidate placement to disqualify.
integer
required
Unique ID of the configured disqualification reason to apply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_CANDIDATERetrieve a candidate by ID, returning selected profile details for the connected or specified company.

Input Parameters

string
Company ID or subdomain. Can be either the numerical company ID or the company subdomain. If not provided, uses the subdomain from the connection.
integer
required
Unique identifier of the candidate to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_CANDIDATE_MAILBOXRetrieve email threads and messages associated with a Recruitee candidate.

Input Parameters

integer
required
Unique ID of the candidate whose mailbox to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_CANDIDATESRetrieve a company’s candidates, optionally filtering and sorting the results. Use limit and offset to paginate; if neither is supplied, the API returns all candidates. The company can be specified explicitly or taken from the connection.

Input Parameters

array
List of candidate IDs to retrieve.
string ("by_date" | "by_last_message")
Sort by date or by last message.
integer
Maximum number of candidates to return.
string
Search term to filter candidates by name or offer.
integer
Number of candidates to skip before returning results (pagination offset).
boolean
If true, only deleted candidates are returned.
integer
Filter candidates by specific offer ID.
boolean
If true, only qualified candidates are returned.
string
Company ID or subdomain. Can be either the numerical company ID or the company subdomain. If not provided, uses the subdomain from the connection.
string
Return candidates created after this ISO 8601 timestamp.
boolean
If true, only disqualified candidates are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_COMPANY_IDRetrieve company details including an ID from the authenticated admin response. If the response contains an admin company list, the first company is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_COMPANY_OFFER_PUBLICRetrieve a published job offer by ID or slug from a Recruitee careers site. The lookup requires an authenticated connection and targets the first company associated with the authenticated admin.

Input Parameters

string
required
Offer ID or slug, e.g., ‘12345’ or ‘software-engineer’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_DEPARTMENTSTool to retrieve a list of company departments. Use when you need to reference or assign offers or candidates to departments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_LOCATIONSTool to retrieve a list of company locations. Use when you need to see all location options before assigning them to offers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_NOTESList notes for a candidate with optional pagination. The returned note fields include structured body data and metadata, but not plain-text or HTML note bodies or note IDs.

Input Parameters

integer
Maximum number of notes to return per page.
integer
Number of notes to skip.
integer
required
Unique identifier of the candidate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_OFFERRetrieve a full authenticated company offer or talent-pool record by ID.

Input Parameters

integer
required
Unique ID of the company offer or talent pool to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_OFFERSTool to retrieve a list of all job offers. Use after authentication to browse or paginate your company’s complete set of offers.

Input Parameters

integer
Maximum number of offers to return (1-100).
string
Search term to filter job offers.
integer
Number of offers to skip (for pagination).
string
Company ID or subdomain. Can be either the numerical company ID or the company subdomain. If not provided, uses the subdomain from the connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_PIPELINE_STAGESTool 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.”

Input Parameters

integer
required
ID of the job offer to retrieve pipeline stages for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_GET_TAGSRetrieve all tags with optional filtering and pagination. Search by name, sort by name or usage count, and paginate through results.

Input Parameters

integer
Page number of results (minimum 1).
string
Search term to filter tags by name.
string ("name" | "taggings_count")
Field to sort by: ‘name’ or ‘taggings_count’.
integer
Number of tags per page (1-100).
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_LIST_EEO_JOB_CATEGORIESTool to retrieve available EEO (Equal Employment Opportunity) job categories. Use when you need to see standard EEO job classification options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_LIST_INTERVIEW_EVENTSList scheduled interviews using ownership, status, attendee, and date filters.

Input Parameters

integer
Page number to return. The provider requires limit with page.
integer
Maximum number of interview events per page.
string ("my" | "all")
Ownership filter: events assigned to me or all events.
string ("upcoming" | "past_due" | "all")
Schedule filter for returned interview events.
string
Inclusive range end date in YYYY-MM-DD format.
string
IANA timezone used to interpret the date range.
array
Only return events assigned to these administrator IDs.
string
Inclusive range start date in YYYY-MM-DD format.
integer
Only return events for this candidate ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_LIST_INVOICESList billing invoices for a company. An empty list can also indicate an unauthorized, forbidden, or not-found response, or an unrecognized response format.

Input Parameters

string
Company ID or subdomain. Can be either the numerical company ID or the company subdomain. If not provided, uses the subdomain from the connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_LIST_LOCALIZATION_SETTINGSTool to retrieve localization settings including proposed time format and start day of the week. Use when you need to check regional or time display preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_LIST_SHARE_COUNTRIESRetrieves country reference data with localized names and phone codes when available. For locale-grouped responses, region codes are not populated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_LIST_SHARE_EEO_ANSWERSTool to retrieve available EEO (Equal Employment Opportunity) answers. Use when you need to see available answer options for EEO compliance questions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_UPDATE_CANDIDATEUpdates an existing candidate’s information in Recruitee. Use this to modify candidate details such as name, contact info, cover letter, tags, and social links. All fields except candidate_id are optional - only provide the fields you want to update. The API performs a partial update (PATCH), preserving any fields you don’t specify.

Input Parameters

string
Full name of the candidate.
array
List of tags associated with the candidate.
string
Primary email address of the candidate. Note: The Recruitee API stores emails as an array, so this field may not update the candidate’s email list as expected.
string
Primary phone number of the candidate. Note: The Recruitee API stores phones as an array, so this field may not update the candidate’s phone list as expected.
string
URL to the candidate’s photo.
array
List of offer IDs to associate with the candidate.
string
URL to the candidate’s resume.
string
Source from which the candidate was obtained. Must be a valid source defined in the Recruitee system. Common values include ‘manual’, ‘career_site’, etc. Invalid sources will result in a 422 error.
integer
required
Unique identifier of the candidate to update.
string
Cover letter text for the candidate.
List of social media profile links for the candidate.
object
Custom fields for the candidate as defined by the company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_UPDATE_NOTEUpdate a note’s text or pin status by note ID. A candidate ID is required but is not used to scope or verify the update.

Input Parameters

string
Updated text content of the note.
boolean
True to pin the note, false to unpin.
integer
required
Unique identifier of the note to update.
integer
required
Unique identifier of the candidate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RECRUITEE_UPDATE_OFFERUpdate an existing Recruitee job offer or talent pool by ID. Supply the details to change, such as title, description, status, locations, work type, visibility, or application form settings; omitted fields are not sent in the update.

Input Parameters

string ("job" | "talent_pool")
Type of the offer: ‘job’ for standard job postings or ‘talent_pool’ for talent pools.
string
The title of the job offer.
boolean
Display the job as hybrid (combination of on-site and remote) on the careers site.
boolean
Display the job as fully remote on the careers site.
string ("draft" | "internal" | "published" | "closed" | "archived")
Current status of the offer. Options: ‘draft’ (not visible), ‘internal’ (visible to team), ‘published’ (public), ‘closed’ (no longer accepting applications), ‘archived’ (hidden from all views).
boolean
Display the job as on-site on the careers site.
integer
required
The unique identifier of the offer to update. Required.
string ("required" | "optional" | "off")
CV/resume upload field setting in application form. Options: ‘required’ (must upload), ‘optional’ (can upload), ‘off’ (field hidden).
string
Detailed description of the job offer. Supports HTML formatting.
array
List of location IDs for the job offer. Use Get Locations action to retrieve valid IDs.
string
Job requirements and qualifications. Supports HTML formatting.
integer
Department ID to assign the offer to. Use Get Departments action to retrieve valid IDs.
string ("required" | "optional" | "off")
Phone number field setting in application form. Options: ‘required’ (must provide), ‘optional’ (can provide), ‘off’ (field hidden).
string ("required" | "optional" | "off")
Photo upload field setting in application form. Options: ‘required’ (must upload), ‘optional’ (can upload), ‘off’ (field hidden).
string
Custom question text for the location picker in the application form. Only used when ‘locations_question’ is in visibility_options.
array
Job visibility and feature options. Include ‘indeed’ to post on Indeed, ‘linkedin’ for LinkedIn, ‘social_share’ for social media sharing, ‘job_location’ to show location, ‘locations_question’ to enable location picker in application form.
string ("required" | "optional" | "off")
Cover letter field setting in application form. Options: ‘required’ (must provide), ‘optional’ (can provide), ‘off’ (field hidden).
string ("single_choice" | "multiple_choice")
Type of location selection in application form: ‘single_choice’ allows one location, ‘multiple_choice’ allows multiple.
boolean
Whether applicants must answer the location question to submit their application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not