recruitee_get_current_user
Get the current user
Fetch the Recruitee user the API token belongs to — name, email, role, role abilities and company id. A cheap way to confirm the token and company id are right. Recruitee: GET /c/{company_id}/admin.
无需输入参数。
recruitee_list_team_members
List team members
List the company's team members (memberships): admin_id, role, whether they are a recruiter or hiring manager, and the jobs they can access. Use admin_id values for task assignees and filters. User names/emails are in the `references` array. Recruitee: GET /c/{company_id}/memberships.
输入参数pagelimitqueryrole_idsort_bysort_order
recruitee_search_candidates
Search candidates
Search the company's candidates with Recruitee's candidate search (the same engine as the app's filters). `query` is a free-text search across name, emails, phones, tags, sources, job assignments, current stage, cover letter and CV content. `filters` accepts Recruitee filter objects verbatim, e.g. {"field":"created_at","gte":1548975600} (Unix seconds), {"field":"has_cv","eq":true}, {"filter":"tags","id":{"in":[12]}}, {"filter":"stages","name":{"in":["Phone interview"]}}. Returns `hits` (with each candidate's placements: job + current stage) and `total`. Recruitee: GET /c/{company_id}/search/new/candidates.
输入参数pagelimitqueryfilterssort_by
recruitee_list_candidates
List candidates
List candidates, newest first, optionally filtered by job, search, qualification, ids or creation date. Default 25 per page. detail auto returns whole records where they fit; if one record or page metadata is too large, explicitly marked summaries preserve candidate ids and omit other fields/references. detail full requires whole records; summary always returns summaries. Pages can be smaller than limit: continue with pagination.next_offset as offset and the same filters; null means finished. Do not advance by limit. Recruitee: GET /c/{company_id}/candidates.
输入参数idssortlimitquerydetailoffsetoffer_idqualifieddisqualifiedcreated_after
recruitee_get_candidate
Get one candidate
Fetch one candidate's full profile: contact details, sources, tags, cover letter, CV URL, custom fields, ratings, and `placements` — one per job they are on, each with its placement id and current stage. The placement id is what recruitee_move_candidate_stage needs. Recruitee: GET /c/{company_id}/candidates/{id}.
输入参数candidate_id必填
recruitee_list_candidate_notes
List a candidate's notes
List the notes on a candidate's profile, with replies, author admin_id and visibility. Recruitee: GET /c/{company_id}/candidates/{candidate_id}/notes.
输入参数candidate_id必填
recruitee_list_offers
List jobs
List the company's jobs (Recruitee calls them offers) with id, title, status, slug, department_id, recruiter_id, hiring_manager_id and pipeline_template_id. Filter by status, department, location, recruiter, hiring manager, tag and more; add heavy fields with `include` (e.g. counters for candidate counts, description, salary, location_ids). Paginated with limit + page (default 1000 per page); `meta.total_count` gives the total. Recruitee: GET /c/{company_id}/offers.
输入参数pagelimitincludetag_idsstatusesoffer_idscategorieslang_codesprioritieslocation_idsrecruiter_idsdepartment_ids另有 2 个
recruitee_get_offer
Get one job
Fetch one job or talent pool by id with its full details: description, requirements, location, salary, employment type, candidate counters and pipeline_template_id. Recruitee: GET /c/{company_id}/offers/{id}.
输入参数offer_id必填
recruitee_get_pipeline_template
Get a hiring pipeline
Fetch a pipeline template with its ordered stages (id, name, group, category). A job's `pipeline_template_id` (from recruitee_list_offers / recruitee_get_offer) names its pipeline; the stage ids here are what recruitee_move_candidate_stage takes. Recruitee: GET /c/{company_id}/pipeline_templates/{id}.
输入参数pipeline_template_id必填
recruitee_list_departments
List departments
List the company's departments with their ids and job counts. Recruitee: GET /c/{company_id}/departments.
无需输入参数。
recruitee_list_tags
List candidate tags
List the company's candidate tags with ids and usage counts. Tag ids are used in recruitee_search_candidates filters. Recruitee: GET /c/{company_id}/tags.
输入参数querysort_bysort_order
recruitee_list_disqualify_reasons
List disqualify reasons
List the company's configured disqualification reasons (id, name, position). Useful for reading why candidates were disqualified. Recruitee: GET /c/{company_id}/disqualify_reasons.
无需输入参数。
recruitee_list_tasks
List tasks
List recruiting tasks (title, description, due date, completed, candidate_id). With candidate_id, lists that candidate's tasks (Recruitee: GET /c/{company_id}/candidates/{candidate_id}/tasks — only `status` applies). Otherwise lists company tasks with scope, assignee, sorting and paging (Recruitee: GET /c/{company_id}/tasks).
输入参数pagelimitscopestatussort_byadmin_idssort_ordercandidate_id
recruitee_list_interview_events
List interviews
List scheduled interview events (candidate_id, offer_id, stage_id, start time, duration, location, attendees). Defaults to upcoming events for the whole company; narrow by candidate, date range or interviewer. Recruitee: GET /c/{company_id}/interview/events.
输入参数pagelimitscopestatusend_datetimezoneadmin_idsstart_datecandidate_id
recruitee_list_evaluations
List evaluations
List interview results — evaluations (rating + note) and questionnaire scorecards — optionally for one candidate or by selected reviewers. Recruitee: GET /c/{company_id}/interview/results.
输入参数kindpagelimitscopeadmin_idscandidate_id
recruitee_create_candidate
Create a candidate
WRITE: add a candidate manually (as if a recruiter added them in the app — no auto-confirmation email is sent), optionally assigning them straight to one or more jobs in the job's default stage. Recruitee: POST /c/{company_id}/candidates.
输入参数name必填linksemailsphonessourcesoffer_idscover_lettersocial_linksremote_cv_url
recruitee_update_candidate
Update a candidate
WRITE: update a candidate's name or contact details. Only the fields you pass change; list fields (emails, phones, links) REPLACE the existing list, so pass the full list you want. Recruitee: PATCH /c/{company_id}/candidates/{id}.
输入参数namelinksemailsphonescandidate_id必填cover_lettersocial_links
recruitee_add_candidate_note
Add a note to a candidate
WRITE: add a note to a candidate's profile, visible to the team. Recruitee: POST /c/{company_id}/candidates/{candidate_id}/notes.
输入参数body必填candidate_id必填
recruitee_add_candidate_tags
Tag a candidate
WRITE: add one or more tags to a candidate (existing tags are reused by name; new names create new tags). Recruitee: POST /c/{company_id}/candidates/{candidate_id}/tags.
输入参数tags必填candidate_id必填
recruitee_assign_candidate_to_offer
Add a candidate to a job
WRITE: put an existing candidate on a job (or talent pool) — creates a placement in the pipeline's first stage. Pass exactly one of offer_id or talent_pool_id. Recruitee: POST /c/{company_id}/placements.
输入参数offer_idcandidate_id必填talent_pool_id
recruitee_move_candidate_stage
Move a candidate to another stage
WRITE: move a candidate to another stage of a job's pipeline. Takes the PLACEMENT id (from recruitee_get_candidate → placements[].id, one per job) and the destination stage id (from recruitee_get_pipeline_template). Moving to a 'hired' stage also requires work_location_id. Stage automations configured in Recruitee may run. Undo by moving back. Recruitee: PATCH /c/{company_id}/placements/{id}/change_stage.
输入参数stage_id必填placement_id必填work_location_id
recruitee_create_task
Create a task
WRITE: create a recruiting task, optionally about a candidate, assigned to team members (admin ids from recruitee_list_team_members), with an optional due date. Recruitee: POST /c/{company_id}/tasks.
输入参数title必填due_datetimezoneadmin_idsdescriptioncandidate_id