The Recruitee connector lets your AI agent act in each user's Recruitee account. Each user connects their own Recruitee access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 53 tools.
- Tools
- 53
- What they doRead · write · destructive
- 26 · 23 · 426 read23 write4 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Recruitee connection
In AgentKit > Connections, create a Recruitee connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'recruitee'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Recruitee:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'recruitee_list_admins',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "recruitee"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Recruitee:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="recruitee_list_admins",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Recruitee credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolrecruitee_get_candidateRetrieve one Recruitee candidate by ID.Read-onlyGet Candidate
Retrieve one Recruitee candidate by ID. Returns the candidate profile (name, emails, phones, source, ratings, timestamps, hired status) and a references array of related records. Use get_candidate when you have the candidate ID. Use recruitee_search_candidates to find the ID first.
Inputs
idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
recruitee_get_departmentRetrieve one Recruitee department by ID.Read-onlyGet Department
Retrieve one Recruitee department by ID. Returns the department with its id, name, and translations. Use get_department when you have the department ID from recruitee_list_departments.
Inputs
idintegerrequired- Numeric ID of the department. Get it from recruitee_list_departments.
recruitee_get_locationRetrieve one Recruitee location with its translations.Read-onlyGet Location
Retrieve one Recruitee location with its translations. Returns the location with id, country code, state code, and translated names and addresses. Use get_location when you have the location ID from recruitee_list_locations.
Inputs
idintegerrequired- Numeric ID of the location. Get it from recruitee_list_locations.
recruitee_get_offerRetrieve one Recruitee job offer or talent pool by ID.Read-onlyGet Offer
Retrieve one Recruitee job offer or talent pool by ID. Returns the offer with title, status, description, requirements, department, locations, and pipeline details. Use get_offer when you have the offer ID. Use recruitee_list_offers to find it.
Inputs
idintegerrequired- Numeric ID of the Recruitee offer (job or talent pool). Get it from recruitee_list_offers.
recruitee_get_pipeline_templateRetrieve one Recruitee pipeline template with its ordered stages.Read-onlyGet Pipeline Template
Retrieve one Recruitee pipeline template with its ordered stages. Returns the pipeline_template with id, title, and its stages (id, name, category). Use get_pipeline_template to find stage IDs for recruitee_change_placement_stage.
Inputs
idintegerrequired- Numeric ID of the pipeline template. Get it from recruitee_list_pipeline_templates or from an offer's pipeline details.
recruitee_get_requisitionRetrieve one Recruitee requisition by ID.Read-onlyGet Requisition
Retrieve one Recruitee requisition by ID. Returns the requisition with title, status, department, location, openings, and approval details. Use get_requisition when you have the ID from recruitee_list_requisitions.
Inputs
idintegerrequired- Numeric ID of the requisition. Get it from recruitee_list_requisitions.
recruitee_get_talent_poolRetrieve one Recruitee talent pool by ID.Read-onlyGet Talent Pool
Retrieve one Recruitee talent pool by ID. Returns the talent_pool with title, status, and description. Use get_talent_pool when you have the ID from recruitee_list_talent_pools.
Inputs
idintegerrequired- Numeric ID of the talent pool. Get it from recruitee_list_talent_pools.
recruitee_get_taskRetrieve one Recruitee task by ID.Read-onlyGet Task
Retrieve one Recruitee task by ID. Returns the task with title, description, due date, assignees, candidate, and completion state. Use get_task when you have the task ID from recruitee_list_tasks.
Inputs
idintegerrequired- Numeric ID of the task. Get it from recruitee_list_tasks.
recruitee_list_adminsList team members (admins) of the Recruitee company.Read-onlyList Admins
List team members (admins) of the Recruitee company. Returns the admins with id, name, email, and role. Use list_admins to find admin IDs for recruitee_create_task and recruitee_add_candidate_followers.
Inputs
authorized_for_candidate_idinteger- Return only admins who have access to this candidate.
recruitee_list_candidate_activitiesList the activity timeline of a Recruitee candidate, such as stage changes, notes, emails and edits.Read-onlyList Candidate Activities
List the activity timeline of a Recruitee candidate, such as stage changes, notes, emails and edits. Returns the candidate's activity entries in time order. Use list_candidate_activities to audit what happened to a candidate.
Inputs
candidate_idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
recruitee_list_candidate_attachmentsList files attached to a Recruitee candidate, such as CVs, cover letters and note attachments.Read-onlyList Candidate Attachments
List files attached to a Recruitee candidate, such as CVs, cover letters and note attachments. Returns an attachments array with file name, kind, source, and download details. Use list_candidate_attachments to find documents for a candidate.
Inputs
candidate_idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
kindstring- Filter by attachment kind: document, image, or other.one of
documentimageother sourcestring- Filter by where the attachment came from: note, result, open_question, offer, requisition, requisition_approval_request, talent_pool, guest, candidate, or mailbox.one of
noteresultopen_questionofferrequisitionrequisition_approval_requesttalent_poolguestcandidatemailbox
recruitee_list_candidate_notesList notes written on a Recruitee candidate's profile.Read-onlyList Candidate Notes
List notes written on a Recruitee candidate's profile. Returns a notes array with note body, author, visibility, and timestamps, plus a references array of authors. Use list_candidate_notes to read the note history. Use recruitee_create_candidate_note to add one.
Inputs
candidate_idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
recruitee_list_candidate_tasksList tasks linked to a Recruitee candidate, optionally limited to completed or uncompleted tasks.Read-onlyList Candidate Tasks
List tasks linked to a Recruitee candidate, optionally limited to completed or uncompleted tasks. Returns a tasks array with title, description, due date, assignees, and completion state. Use list_candidate_tasks for one candidate. Use recruitee_list_tasks for tasks across the company.
Inputs
candidate_idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
statusstring- Limit tasks to completed or uncompleted ones. Leave empty for all tasks.one of
completeduncompleted
recruitee_list_candidatesList candidates in the Recruitee company, optionally filtered by offer, qualification status, IDs or creation date.Read-onlyList Candidates
List candidates in the Recruitee company, optionally filtered by offer, qualification status, IDs or creation date. Returns a candidates array with id, name, emails, phones, source, and timestamps, plus a references array of related admins and offers. Use list_candidates to browse or page through candidates. Use recruitee_search_candidates for free-text or multi-field filtering, and recruitee_get_candidate for one candidate's full profile.
Inputs
created_afterstring- Return only candidates created after this date, for example 2026-01-31.
deletedboolean- When true, return only deleted candidates.
disqualifiedboolean- When true, return only disqualified candidates.
idsstring- Comma-separated candidate IDs to return, for example 234221,4211412.
limitinteger- Maximum number of candidates to return. Default 100, maximum 1000.
offer_idstring- Return only candidates assigned to this offer. Pass the offer ID or slug.
offsetinteger- Number of candidates to skip, for paging. The next page offset is the current offset plus limit.
qualifiedboolean- When true, return only qualified (not disqualified) candidates.
querystring- Free-text search matched against the candidate's name or offer title.
sortstring- Sort order: by_date (default) or by_last_message.one of
by_dateby_last_message
recruitee_list_departmentsList departments in the Recruitee company.Read-onlyList Departments
List departments in the Recruitee company. Returns a departments array with id and name. Use list_departments to find a department ID for recruitee_create_offer or recruitee_update_offer.
Inputs
This tool takes no inputs.
recruitee_list_disqualify_reasonsList the disqualify reasons configured in the Recruitee company.Read-onlyList Disqualify Reasons
List the disqualify reasons configured in the Recruitee company. Returns a disqualify_reasons array with id, name, and any automated actions. Use list_disqualify_reasons to get a reason ID for recruitee_disqualify_placement.
Inputs
This tool takes no inputs.
recruitee_list_locationsList locations defined in the Recruitee company.Read-onlyList Locations
List locations defined in the Recruitee company. Returns a locations array with id, name, address, and country, plus paging meta. Use list_locations to find location IDs for offers and hires.
Inputs
limitinteger- Maximum number of locations to return.
pageinteger- Page number, starting at 1.
querystring- Search text matched against location name and full address.
scopestring- Which locations to return: all (default), active, or archived.one of
allactivearchived view_modestring- brief (default) returns locations without translations; full includes translations and active offer counters.one of
brieffull
recruitee_list_offer_placementsList the candidates in a Recruitee offer's pipeline, grouped by stage.Read-onlyList Offer Placements
List the candidates in a Recruitee offer's pipeline, grouped by stage. Returns a stages array, each with its stage details and the placements (candidate memberships) in that stage. Use list_offer_placements to see the pipeline board and to get placement IDs for recruitee_change_placement_stage.
Inputs
offer_idintegerrequired- Numeric ID of the offer, or its slug. Get it from recruitee_list_offers.
disqualifiedboolean- When true, return only disqualified placements.
qualifiedboolean- When true, return only qualified placements.
sort_bystring- Field to sort placements by.
sort_orderstring- Sort direction: asc or desc.one of
ascdesc stage_idinteger- Return only placements in this pipeline stage. Get stage IDs from recruitee_get_pipeline_template.
recruitee_list_offersList job offers and talent pools in the Recruitee company, with filters for status, department, location and IDs.Read-onlyList Offers
List job offers and talent pools in the Recruitee company, with filters for status, department, location and IDs. Returns an offers array with id, title, status, kind, department, location, and slug. Use list_offers to browse jobs. Use recruitee_get_offer for one offer's full details.
Inputs
department_idsarray- Return only offers in these department IDs.
includearray- Extra fields to include per offer: description, requirements, highlight, work_models, salary, dynamic_fields, follower_ids, location_ids, requisition_ids, tags, job_scheduler, issues, counters.
limitinteger- Maximum number of offers to return. Default 1000.
location_idsarray- Return only offers in these location IDs.
offer_idsarray- Return only offers with these IDs.
pageinteger- Page number, starting at 1.
statusesarray- Statuses to include: draft, published, internal, closed, or archived. Leave empty for all statuses.
recruitee_list_pipeline_templatesList hiring pipeline templates in the Recruitee company.Read-onlyList Pipeline Templates
List hiring pipeline templates in the Recruitee company. Returns a pipeline_templates array with id, title, and stages. Use list_pipeline_templates to see available pipelines. Use recruitee_get_pipeline_template for one pipeline's stages.
Inputs
titlestring- Filter pipeline templates by title.
recruitee_list_requisitionsList hiring requisitions in the Recruitee company.Read-onlyList Requisitions
List hiring requisitions in the Recruitee company. Returns a requisitions array with title, status, department, location, and openings. Use list_requisitions to browse. Use recruitee_get_requisition for one requisition.
Inputs
qstring- Search text matched against title, guid, and location.
scopestring- active (default), requested_by_me, need_my_approval, or archived.one of
activerequested_by_meneed_my_approvalarchived sort_bystring- Sort field, for example title, id, status, department_name, created_at, location, hires_count, or openings_count.
recruitee_list_sourcesList candidate sources defined in the Recruitee company.Read-onlyList Sources
List candidate sources defined in the Recruitee company. Returns a sources array with id and name, plus paging meta. Use list_sources to see valid sources before recruitee_add_candidate_sources.
Inputs
This tool takes no inputs.
recruitee_list_talent_poolsList talent pools in the Recruitee company.Read-onlyList Talent Pools
List talent pools in the Recruitee company. Returns a talent_pools array with id, title, and status, plus paging meta. Use list_talent_pools to browse pools. Use recruitee_get_talent_pool for one pool.
Inputs
limitinteger- Maximum number of talent pools to return.
offsetinteger- Number of talent pools to skip, for paging.
scopestring- archived returns only archived pools; not_archived returns all but archived; empty returns all.one of
archivednot_archived
recruitee_list_tasksList tasks in the Recruitee company, filtered by scope, status or assignee.Read-onlyList Tasks
List tasks in the Recruitee company, filtered by scope, status or assignee. Returns a tasks array with title, due date, assignees, candidate, and completion state, plus paging meta and a references array. Use list_tasks across the company. Use recruitee_list_candidate_tasks for a single candidate.
Inputs
admin_idsarray- Return only tasks assigned to these admin IDs.
limitinteger- Maximum number of tasks per page.
pageinteger- Page number, starting at 1.
scopestring- my (your tasks), unassigned, or all.one of
myunassignedall sort_bystring- Order tasks by due_date, created_at, or completed_at.one of
due_datecreated_atcompleted_at sort_orderstring- Sort direction: asc or desc.one of
ascdesc statusstring- Limit tasks to completed or uncompleted ones.one of
completeduncompleted
recruitee_search_candidatesSearch candidates with the Recruitee full-search endpoint, using structured filters such as free text, status, source, tags, jobs, and dates.Read-onlySearch Candidates
Search candidates with the Recruitee full-search endpoint, using structured filters such as free text, status, source, tags, jobs, and dates. Returns total (match count), hits (matching candidates), and aggregations when requested. Use search_candidates for multi-field or full-text filtering. Use recruitee_list_candidates for simple paging by offer or status.
Inputs
deletedboolean- When true, search only deleted candidates.
filters_jsonstring- JSON array of filter objects, serialized to a string. Each filter targets one field, for example free text across the profile, a status, a source, a tag, or a creation date range. Example: [{"field":"all","query":"python developer"}].
limitinteger- Maximum number of candidates per page. Default 60.
pageinteger- Page number, starting at 1.
sort_bystring- Sort order as <field>_<asc|desc>, for example created_at_desc (default), relevance_desc, candidate_name_asc, or updated_at_desc.
recruitee_add_candidate_followersAdd team members as followers of a Recruitee candidate so they receive updates about that candidate.WriteAdd Candidate Followers
Add team members as followers of a Recruitee candidate so they receive updates about that candidate. Returns the candidate record with its updated followers. Use add_candidate_followers to subscribe people. Get admin IDs from recruitee_list_admins.
Inputs
admin_idsarrayrequired- IDs of the admins (team members) who should follow the candidate. Get them from recruitee_list_admins.
idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
recruitee_add_candidate_sourcesAdd one or more sources to a Recruitee candidate, recording where the candidate came from.WriteAdd Candidate Sources
Add one or more sources to a Recruitee candidate, recording where the candidate came from. Returns the sources now attached to the candidate. Use add_candidate_sources to record origin such as Indeed or LinkedIn. Use recruitee_list_sources to see existing sources.
Inputs
candidate_idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
sourcesarrayrequired- Source names to add to the candidate.
recruitee_archive_offerArchive a Recruitee job offer.WriteArchive Offer
Archive a Recruitee job offer. Moves the job to the archive. Returns the offer with its updated status. Use recruitee_publish_offer, recruitee_unpublish_offer, recruitee_close_offer, recruitee_archive_offer and recruitee_unarchive_offer to move an offer between statuses. Use recruitee_update_offer to edit content.
Inputs
idintegerrequired- Numeric ID of the Recruitee offer (job or talent pool). Get it from recruitee_list_offers.
recruitee_change_placement_stageMove a candidate to another pipeline stage within a Recruitee offer.WriteChange Placement Stage
Move a candidate to another pipeline stage within a Recruitee offer. Returns the updated placement and a references array of related records. Use change_placement_stage to advance or return a candidate. Get stage IDs from recruitee_get_pipeline_template and placement IDs from recruitee_list_offer_placements.
Inputs
idintegerrequired- Numeric ID of the placement, which is a candidate's membership in one job offer. Get it from recruitee_list_offer_placements or from the placement object returned when a candidate is added to an offer.
stage_idintegerrequired- Numeric ID of the destination pipeline stage. Get it from recruitee_get_pipeline_template.
hired_atstring- ISO 8601 datetime when the candidate was hired. Use when moving to the hired stage.
job_starts_atstring- ISO 8601 datetime when the candidate starts the job. Use when moving to the hired stage.
opening_idinteger- Opening ID, needed when requisitions are enabled and the candidate is marked as hired.
proceedboolean- When true, place the candidate at the top of the destination stage list.
run_actionsboolean- When true, automated actions configured on the stage are triggered.
work_location_idinteger- Location ID, needed when marking a candidate as hired. Get it from recruitee_list_locations.
recruitee_close_offerClose a Recruitee job offer.WriteClose Offer
Close a Recruitee job offer. Stops accepting applications while keeping the job and its candidates. Returns the offer with its updated status. Use recruitee_publish_offer, recruitee_unpublish_offer, recruitee_close_offer, recruitee_archive_offer and recruitee_unarchive_offer to move an offer between statuses. Use recruitee_update_offer to edit content.
Inputs
idintegerrequired- Numeric ID of the Recruitee offer (job or talent pool). Get it from recruitee_list_offers.
recruitee_complete_taskMark a Recruitee task as completed or reopen it.WriteComplete Task
Mark a Recruitee task as completed or reopen it. Returns the updated task and a references array of related records. Use complete_task to change completion state. Use recruitee_update_task to edit other fields.
Inputs
completedbooleanrequired- True to mark the task completed, false to reopen it.
idintegerrequired- Numeric ID of the task. Get it from recruitee_list_tasks.
recruitee_create_candidateCreate a candidate in Recruitee, optionally assigning them to one or more offers.WriteCreate Candidate
Create a candidate in Recruitee, optionally assigning them to one or more offers. Returns the created candidate and a references array of related records. The candidate is marked as manually added and receives no automatic confirmation email. Use create_candidate to add a new person. Use recruitee_create_placement to add an existing candidate to another offer.
Inputs
namestringrequired- Full name of the candidate.
cover_letterstring- Cover letter text for the candidate.
emailsarray- Email addresses of the candidate.
linksarray- Other relevant URLs, such as a portfolio or personal site.
offersarray- IDs of the offers to assign the candidate to, placing them in each offer's first pipeline stage.
phonesarray- Phone numbers of the candidate.
remote_cv_urlstring- Public URL of a CV file for Recruitee to download and attach.
social_linksarray- Social profile URLs of the candidate.
sourcesarray- Source tags describing where the candidate came from, for example Indeed or LinkedIn.
recruitee_create_candidate_noteAdd a text note to a Recruitee candidate's profile.WriteCreate Candidate Note
Add a text note to a Recruitee candidate's profile. Returns the created note and a references array of related records. Use create_candidate_note to record feedback or context. Use recruitee_create_task to schedule a follow-up action instead.
Inputs
bodystringrequired- Text of the note.
candidate_idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
recruitee_create_departmentsCreate one or more departments in the Recruitee company.WriteCreate Departments
Create one or more departments in the Recruitee company. Returns a departments array containing the departments. Use create_departments to add departments. Use recruitee_update_department to rename one.
Inputs
departmentsarrayrequired- Names of the departments to create.
recruitee_create_locationCreate a location in the Recruitee company for use on offers.WriteCreate Location
Create a location in the Recruitee company for use on offers. Returns the created location. Use create_location when no suitable location exists in recruitee_list_locations.
Inputs
country_codestringrequired- Two-letter ISO country code of the location.
translationsarrayrequired- Localized details as a list of objects, each with lang_code, name, city, street, postal_code and an optional note. Example: [{"lang_code":"en","name":"Poznan HQ","city":"Poznan","street":"ul. Wiosny Ludow 2","postal_code":"60-001"}].
state_codestring- State or region code within the country.
recruitee_create_offerCreate a job offer or talent pool in Recruitee as a draft.WriteCreate Offer
Create a job offer or talent pool in Recruitee as a draft. Returns the created offer with its ID, status, and slug. Use create_offer to open a new job. Use recruitee_publish_offer afterwards to make it live, and recruitee_update_offer to change an existing offer.
Inputs
descriptionstringrequired- Offer description as HTML.
titlestringrequired- Title of the offer, for example the job title.
department_idstring- ID of an existing department to assign the offer to. Get it from recruitee_list_departments.
hybridboolean- When true, the careers site shows the offer as hybrid.
kindstring- Type of offer: job (default) or talent_pool.one of
jobtalent_pool location_idsarray- IDs of the locations for the offer. Get them from recruitee_list_locations.
on_siteboolean- When true, the careers site shows the offer as on-site. At least one of on_site, hybrid or remote must be true for work model fields.
remoteboolean- When true, the careers site shows the offer as remote. Location details are still needed because some job boards require them.
requirementsstring- Offer requirements as HTML. Optional for talent pools.
recruitee_create_placementAdd an existing Recruitee candidate to a job offer or talent pool by creating a placement.WriteCreate Placement
Add an existing Recruitee candidate to a job offer or talent pool by creating a placement. Returns the placement and a references array of related records. Use create_placement to assign a candidate to another job. Use recruitee_create_candidate to add a brand new person.
Inputs
candidate_idintegerrequired- Numeric ID of the candidate to add. Get it from recruitee_list_candidates.
location_idsarray- IDs of the locations to attach to the placement.
offer_idinteger- Numeric ID or slug of the offer to add the candidate to. Provide this or talent_pool_id.
talent_pool_idinteger- Numeric ID of the talent pool to add the candidate to. Provide this or offer_id.
recruitee_create_taskCreate a task in Recruitee, optionally linked to a candidate and assigned to team members.WriteCreate Task
Create a task in Recruitee, optionally linked to a candidate and assigned to team members. Returns the created task and a references array of related records. Use create_task to schedule follow-ups. Use recruitee_create_candidate_note to record information instead.
Inputs
titlestringrequired- Name of the task.
admin_idsarray- IDs of the admins the task is assigned to. Get them from recruitee_list_admins.
candidate_idinteger- ID of the candidate the task is about.
descriptionstring- Longer description of the task.
due_datestring- Due date as an ISO 8601 datetime. Needs timezone when set.
timezonestring- IANA timezone of the due date, required when due_date is set.
recruitee_disqualify_placementDisqualify a candidate in one Recruitee offer, recording a disqualify reason.WriteDisqualify Placement
Disqualify a candidate in one Recruitee offer, recording a disqualify reason. Returns the updated placement and a references array of related records. Use disqualify_placement to reject a candidate for one job. Use recruitee_requalify_placement to undo it. Get reasons from recruitee_list_disqualify_reasons.
Inputs
disqualify_reason_idintegerrequired- Numeric ID of the disqualify reason. Get it from recruitee_list_disqualify_reasons.
idintegerrequired- Numeric ID of the placement, which is a candidate's membership in one job offer. Get it from recruitee_list_offer_placements or from the placement object returned when a candidate is added to an offer.
recruitee_publish_offerPublish a Recruitee job offer.WritePublish Offer
Publish a Recruitee job offer. Makes the job visible on the careers site. Fails when the account has no free job slots. Returns the offer with its updated status. Use recruitee_publish_offer, recruitee_unpublish_offer, recruitee_close_offer, recruitee_archive_offer and recruitee_unarchive_offer to move an offer between statuses. Use recruitee_update_offer to edit content.
Inputs
idintegerrequired- Numeric ID of the Recruitee offer (job or talent pool). Get it from recruitee_list_offers.
recruitee_requalify_placementRequalify a previously disqualified candidate in a Recruitee offer.WriteRequalify Placement
Requalify a previously disqualified candidate in a Recruitee offer. Returns the updated placement and a references array of related records. Use requalify_placement to reverse recruitee_disqualify_placement.
Inputs
idintegerrequired- Numeric ID of the placement, which is a candidate's membership in one job offer. Get it from recruitee_list_offer_placements or from the placement object returned when a candidate is added to an offer.
recruitee_unarchive_offerUnarchive a Recruitee job offer.WriteUnarchive Offer
Unarchive a Recruitee job offer. Restores an archived job. Returns the offer with its updated status. Use recruitee_publish_offer, recruitee_unpublish_offer, recruitee_close_offer, recruitee_archive_offer and recruitee_unarchive_offer to move an offer between statuses. Use recruitee_update_offer to edit content.
Inputs
idintegerrequired- Numeric ID of the Recruitee offer (job or talent pool). Get it from recruitee_list_offers.
recruitee_unpublish_offerUnpublish a Recruitee job offer.WriteUnpublish Offer
Unpublish a Recruitee job offer. Takes the job off the careers site and returns it to draft. Returns the offer with its updated status. Use recruitee_publish_offer, recruitee_unpublish_offer, recruitee_close_offer, recruitee_archive_offer and recruitee_unarchive_offer to move an offer between statuses. Use recruitee_update_offer to edit content.
Inputs
idintegerrequired- Numeric ID of the Recruitee offer (job or talent pool). Get it from recruitee_list_offers.
recruitee_update_candidateUpdate fields on an existing Recruitee candidate, such as name, contact details, links or cover letter.WriteUpdate Candidate
Update fields on an existing Recruitee candidate, such as name, contact details, links or cover letter. Returns the updated candidate and a references array of related records. Use update_candidate to change profile data. Use recruitee_add_candidate_tags or recruitee_add_candidate_sources to add tags or sources.
Inputs
idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
cover_letterstring- New cover letter text.
emailsarray- Replacement list of email addresses for the candidate.
linksarray- Replacement list of other relevant URLs.
namestring- New full name of the candidate.
phonesarray- Replacement list of phone numbers for the candidate.
social_linksarray- Replacement list of social profile URLs.
recruitee_update_departmentRename a Recruitee department or set its translated names.WriteUpdate Department
Rename a Recruitee department or set its translated names. Returns the updated department. Use update_department to change a name. Use recruitee_create_departments to add new ones.
Inputs
idintegerrequired- Numeric ID of the department. Get it from recruitee_list_departments.
namestring- New department name.
translationsarray- Translated names, as a list of objects each with lang_code and name. Example: [{"lang_code":"de","name":"Technik"}].
recruitee_update_offerUpdate fields on an existing Recruitee offer, such as title, description, requirements, department or locations.WriteUpdate Offer
Update fields on an existing Recruitee offer, such as title, description, requirements, department or locations. Returns the updated offer. Use update_offer to edit content. Use recruitee_publish_offer, recruitee_close_offer or recruitee_archive_offer to change status.
Inputs
idintegerrequired- Numeric ID of the Recruitee offer (job or talent pool). Get it from recruitee_list_offers.
department_idstring- ID of an existing department to assign the offer to. Get it from recruitee_list_departments.
descriptionstring- Offer description as HTML.
hybridboolean- When true, the careers site shows the offer as hybrid.
location_idsarray- IDs of the locations for the offer. Get them from recruitee_list_locations.
on_siteboolean- When true, the careers site shows the offer as on-site. At least one of on_site, hybrid or remote must be true for work model fields.
remoteboolean- When true, the careers site shows the offer as remote. Location details are still needed because some job boards require them.
requirementsstring- Offer requirements as HTML. Optional for talent pools.
titlestring- Title of the offer, for example the job title.
recruitee_update_taskUpdate a Recruitee task's title, description, due date, candidate or assignees.WriteUpdate Task
Update a Recruitee task's title, description, due date, candidate or assignees. Returns the updated task and a references array of related records. Use update_task to edit fields. Use recruitee_complete_task to mark it done or reopen it.
Inputs
idintegerrequired- Numeric ID of the task. Get it from recruitee_list_tasks.
admin_idsarray- IDs of the admins the task is assigned to. Get them from recruitee_list_admins.
candidate_idinteger- ID of the candidate the task is about.
descriptionstring- Longer description of the task.
due_datestring- Due date as an ISO 8601 datetime. Needs timezone when set.
timezonestring- IANA timezone of the due date, required when due_date is set.
titlestring- Name of the task.
recruitee_delete_candidateDelete a Recruitee candidate by ID.DestructiveDelete Candidate
Delete a Recruitee candidate by ID. Returns the deleted candidate and a references array of related records. Use delete_candidate only when the candidate should be removed. Use recruitee_disqualify_placement to reject a candidate for one job while keeping the profile.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the Recruitee candidate. Get it from recruitee_list_candidates or recruitee_search_candidates.
recruitee_delete_noteDelete a note from Recruitee by note ID.DestructiveDelete Note
Delete a note from Recruitee by note ID. Returns the deleted note and a references array of related records. Use delete_note to remove a note. Get the note ID from recruitee_list_candidate_notes.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the note. Get it from recruitee_list_candidate_notes.
recruitee_delete_taskDelete a Recruitee task by ID.DestructiveDelete Task
Delete a Recruitee task by ID. Returns the deleted task and a references array of related records. Use delete_task to remove a task. Use recruitee_complete_task to close it while keeping the record.
- Idempotent
Inputs
idintegerrequired- Numeric ID of the task. Get it from recruitee_list_tasks.
No tools match.
