> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Recruitee

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

![Recruitee logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/recruitee.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=0bf7d0120600f1a64fc2e37151020e48)

* **Category:** hr talent & recruitment
* **Auth:** API\_KEY, OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 23
* **Triggers:** 0
* **Slug:** `RECRUITEE`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Candidate
>
> **Slug:** `RECRUITEE_CREATE_CANDIDATE`
>
> 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](mailto:jane.doe@example.com)."
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Full name of the candidate.
>
> **tags** `array`
>
> List of tags associated with the candidate.
>
> **email** `string`
>
> Email address of the candidate
>
> **phone** `string`
>
> Phone number of the candidate.
>
> **photo** `string`
>
> URL to the candidate's photo
>
> **offers** `array`
>
> List of offer IDs to associate with the candidate.
>
> **resume** `string`
>
> URL to the candidate's resume
>
> **source** `string`
>
> The source from which the candidate was obtained.
>
> **cover\_letter** `string`
>
> Cover letter text for the candidate.
>
> **social\_links** `array`
>
> List of social media profile links for the candidate.
>
> **custom\_fields** `object`
>
> Custom fields for the candidate as defined by the company.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Note
>
> **Slug:** `RECRUITEE_CREATE_NOTE`
>
> Creates 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
>
> **note** `object` *required*
>
> The note object containing content and optional visibility.
>
> **candidate\_id** `string` *required*
>
> Unique identifier of the candidate to attach the note to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Offer
>
> **Slug:** `RECRUITEE_CREATE_OFFER`
>
> Creates 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
>
> **offer** `object` *required*
>
> The offer object containing details for the new job offer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Candidate
>
> **Slug:** `RECRUITEE_DELETE_CANDIDATE`
>
> Tool 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
>
> **candidate\_id** `integer` *required*
>
> Unique identifier of the candidate to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Tag
>
> **Slug:** `RECRUITEE_DELETE_TAG`
>
> Permanently 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
>
> **tag\_id** `integer` *required*
>
> The unique numeric identifier of the tag to delete. Must be a positive integer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disqualify Placement
>
> **Slug:** `RECRUITEE_DISQUALIFY_PLACEMENT`
>
> Disqualify a candidate placement using a configured reason.
>
> #### Input Parameters
>
> **placement\_id** `integer` *required*
>
> Unique ID of the candidate placement to disqualify.
>
> **disqualify\_reason\_id** `integer` *required*
>
> Unique ID of the configured disqualification reason to apply.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Candidate
>
> **Slug:** `RECRUITEE_GET_CANDIDATE`
>
> Retrieve a candidate by ID, returning selected profile details for the connected or specified company.
>
> #### Input Parameters
>
> **company\_id** `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.
>
> **candidate\_id** `integer` *required*
>
> Unique identifier of the candidate to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Candidate Mailbox
>
> **Slug:** `RECRUITEE_GET_CANDIDATE_MAILBOX`
>
> Retrieve email threads and messages associated with a Recruitee candidate.
>
> #### Input Parameters
>
> **candidate\_id** `integer` *required*
>
> Unique ID of the candidate whose mailbox to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Candidates
>
> **Slug:** `RECRUITEE_GET_CANDIDATES`
>
> Retrieve 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
>
> **ids** `array`
>
> List of candidate IDs to retrieve.
>
> **sort** `string ("by_date" | "by_last_message")`
>
> Sort by date or by last message.
>
> **limit** `integer`
>
> Maximum number of candidates to return.
>
> **query** `string`
>
> Search term to filter candidates by name or offer.
>
> **offset** `integer`
>
> Number of candidates to skip before returning results (pagination offset).
>
> **deleted** `boolean`
>
> If true, only deleted candidates are returned.
>
> **offerId** `integer`
>
> Filter candidates by specific offer ID.
>
> **qualified** `boolean`
>
> If true, only qualified candidates are returned.
>
> **company\_id** `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.
>
> **createdAfter** `string`
>
> Return candidates created after this ISO 8601 timestamp.
>
> **disqualified** `boolean`
>
> If true, only disqualified candidates are returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company ID
>
> **Slug:** `RECRUITEE_GET_COMPANY_ID`
>
> Retrieve company details including an ID from the authenticated admin response. If the response contains an admin company list, the first company is used.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company Offer Public
>
> **Slug:** `RECRUITEE_GET_COMPANY_OFFER_PUBLIC`
>
> Retrieve 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
>
> **identifier** `string` *required*
>
> Offer ID or slug, e.g., '12345' or 'software-engineer'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Departments
>
> **Slug:** `RECRUITEE_GET_DEPARTMENTS`
>
> Tool to retrieve a list of company departments. Use when you need to reference or assign offers or candidates to departments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Locations
>
> **Slug:** `RECRUITEE_GET_LOCATIONS`
>
> Tool to retrieve a list of company locations. Use when you need to see all location options before assigning them to offers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Notes
>
> **Slug:** `RECRUITEE_GET_NOTES`
>
> List 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
>
> **limit** `integer`
>
> Maximum number of notes to return per page.
>
> **offset** `integer`
>
> Number of notes to skip.
>
> **candidate\_id** `integer` *required*
>
> Unique identifier of the candidate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Offer
>
> **Slug:** `RECRUITEE_GET_OFFER`
>
> Retrieve a full authenticated company offer or talent-pool record by ID.
>
> #### Input Parameters
>
> **offer\_id** `integer` *required*
>
> Unique ID of the company offer or talent pool to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Offers
>
> **Slug:** `RECRUITEE_GET_OFFERS`
>
> Tool to retrieve a list of all job offers. Use after authentication to browse or paginate your company's complete set of offers.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of offers to return (1-100).
>
> **query** `string`
>
> Search term to filter job offers.
>
> **offset** `integer`
>
> Number of offers to skip (for pagination).
>
> **company\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Pipeline Stages
>
> **Slug:** `RECRUITEE_GET_PIPELINE_STAGES`
>
> 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."
>
> #### Input Parameters
>
> **offer\_id** `integer` *required*
>
> ID of the job offer to retrieve pipeline stages for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Tags
>
> **Slug:** `RECRUITEE_GET_TAGS`
>
> Retrieve all tags with optional filtering and pagination. Search by name, sort by name or usage count, and paginate through results.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number of results (minimum 1).
>
> **query** `string`
>
> Search term to filter tags by name.
>
> **sort\_by** `string ("name" | "taggings_count")`
>
> Field to sort by: 'name' or 'taggings\_count'.
>
> **per\_page** `integer`
>
> Number of tags per page (1-100).
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order: 'asc' or 'desc'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List EEO Job Categories
>
> **Slug:** `RECRUITEE_LIST_EEO_JOB_CATEGORIES`
>
> Tool to retrieve available EEO (Equal Employment Opportunity) job categories. Use when you need to see standard EEO job classification options.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interview Events
>
> **Slug:** `RECRUITEE_LIST_INTERVIEW_EVENTS`
>
> List scheduled interviews using ownership, status, attendee, and date filters.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return. The provider requires limit with page.
>
> **limit** `integer`
>
> Maximum number of interview events per page.
>
> **scope** `string ("my" | "all")`
>
> Ownership filter: events assigned to me or all events.
>
> **status** `string ("upcoming" | "past_due" | "all")`
>
> Schedule filter for returned interview events.
>
> **end\_date** `string`
>
> Inclusive range end date in YYYY-MM-DD format.
>
> **timezone** `string`
>
> IANA timezone used to interpret the date range.
>
> **admin\_ids** `array`
>
> Only return events assigned to these administrator IDs.
>
> **start\_date** `string`
>
> Inclusive range start date in YYYY-MM-DD format.
>
> **candidate\_id** `integer`
>
> Only return events for this candidate ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Invoices
>
> **Slug:** `RECRUITEE_LIST_INVOICES`
>
> List 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
>
> **company\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Localization Settings
>
> **Slug:** `RECRUITEE_LIST_LOCALIZATION_SETTINGS`
>
> Tool 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Share Countries
>
> **Slug:** `RECRUITEE_LIST_SHARE_COUNTRIES`
>
> Retrieves country reference data with localized names and phone codes when available. For locale-grouped responses, region codes are not populated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Share EEO Answers
>
> **Slug:** `RECRUITEE_LIST_SHARE_EEO_ANSWERS`
>
> Tool to retrieve available EEO (Equal Employment Opportunity) answers. Use when you need to see available answer options for EEO compliance questions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Candidate
>
> **Slug:** `RECRUITEE_UPDATE_CANDIDATE`
>
> Updates 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
>
> **name** `string`
>
> Full name of the candidate.
>
> **tags** `array`
>
> List of tags associated with the candidate.
>
> **email** `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.
>
> **phone** `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.
>
> **photo** `string`
>
> URL to the candidate's photo.
>
> **offers** `array`
>
> List of offer IDs to associate with the candidate.
>
> **resume** `string`
>
> URL to the candidate's resume.
>
> **source** `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.
>
> **candidate\_id** `integer` *required*
>
> Unique identifier of the candidate to update.
>
> **cover\_letter** `string`
>
> Cover letter text for the candidate.
>
> **social\_links** `array`
>
> List of social media profile links for the candidate.
>
> **custom\_fields** `object`
>
> Custom fields for the candidate as defined by the company.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Note
>
> **Slug:** `RECRUITEE_UPDATE_NOTE`
>
> Update 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
>
> **body** `string`
>
> Updated text content of the note.
>
> **pinned** `boolean`
>
> True to pin the note, false to unpin.
>
> **note\_id** `integer` *required*
>
> Unique identifier of the note to update.
>
> **candidate\_id** `integer` *required*
>
> Unique identifier of the candidate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Offer
>
> **Slug:** `RECRUITEE_UPDATE_OFFER`
>
> Update 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
>
> **kind** `string ("job" | "talent_pool")`
>
> Type of the offer: 'job' for standard job postings or 'talent\_pool' for talent pools.
>
> **title** `string`
>
> The title of the job offer.
>
> **hybrid** `boolean`
>
> Display the job as hybrid (combination of on-site and remote) on the careers site.
>
> **remote** `boolean`
>
> Display the job as fully remote on the careers site.
>
> **status** `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).
>
> **on\_site** `boolean`
>
> Display the job as on-site on the careers site.
>
> **offer\_id** `integer` *required*
>
> The unique identifier of the offer to update. Required.
>
> **options\_cv** `string ("required" | "optional" | "off")`
>
> CV/resume upload field setting in application form. Options: 'required' (must upload), 'optional' (can upload), 'off' (field hidden).
>
> **description** `string`
>
> Detailed description of the job offer. Supports HTML formatting.
>
> **location\_ids** `array`
>
> List of location IDs for the job offer. Use Get Locations action to retrieve valid IDs.
>
> **requirements** `string`
>
> Job requirements and qualifications. Supports HTML formatting.
>
> **department\_id** `integer`
>
> Department ID to assign the offer to. Use Get Departments action to retrieve valid IDs.
>
> **options\_phone** `string ("required" | "optional" | "off")`
>
> Phone number field setting in application form. Options: 'required' (must provide), 'optional' (can provide), 'off' (field hidden).
>
> **options\_photo** `string ("required" | "optional" | "off")`
>
> Photo upload field setting in application form. Options: 'required' (must upload), 'optional' (can upload), 'off' (field hidden).
>
> **locations\_question** `string`
>
> Custom question text for the location picker in the application form. Only used when 'locations\_question' is in visibility\_options.
>
> **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.
>
> **options\_cover\_letter** `string ("required" | "optional" | "off")`
>
> Cover letter field setting in application form. Options: 'required' (must provide), 'optional' (can provide), 'off' (field hidden).
>
> **locations\_question\_type** `string ("single_choice" | "multiple_choice")`
>
> Type of location selection in application form: 'single\_choice' allows one location, 'multiple\_choice' allows multiple.
>
> **locations\_question\_required** `boolean`
>
> Whether applicants must answer the location question to submit their application.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
