get_candidate | Fetch one candidate by id (from list_candidates): contact details, sources, tags, and placements (one per offer, with its id, offer_id and stage_id). |
get_offer | Fetch one offer by id (integer, from list_offers): description, requirements, location, department, pipeline template with its stages. |
list_candidates | List candidates, 100 by default. Optional filters: offer_id (string, offer id from list_offers), query (search on the candidate name or offer), qualified / disqualified (booleans), created_after (date string), ids (comma-separated candidate ids), sort (“by_date” or “by_last_message”), limit (1-1000) and offset (number of candidates to skip). To filter on a pipeline stage, use list_stage_candidates. |
list_departments | List the company departments (their id is a department_ids filter of list_offers). |
list_locations | List the company locations (their id is a location_ids filter of list_offers). Optional: scope (“active”, “archived”, “all” — default all), query (search on name and address), view_mode (“brief” default, “full” adds translations and active offer counters), limit, page. |
list_members | List the company team members (memberships, with their role). Optional: query (search), role_id (integer), sort_by (“name”, “role” or “email”), sort_order (“asc” default, or “desc”), limit, page. |
list_offer_stages | List the pipeline stages of an offer: pipeline_template_id is the offer’s pipeline_template_id (from list_offers or get_offer). Returns the template with its stages (id, name, position, group, category); a stage id is the stage_id of list_stage_candidates and move_candidate_stage. |
list_offers | List the company offers (jobs and talent pools), 1000 per page by default. Optional filters, each an array: statuses (among “draft”, “published”, “internal”, “closed”, “archived”), department_ids (from list_departments), location_ids (from list_locations), tag_ids (integers), include (extra fields among “description”, “requirements”, “highlight”, “work_models”, “salary”, “dynamic_fields”, “follower_ids”, “location_ids”, “requisition_ids”, “tags”, “job_scheduler”, “issues”, “counters”); limit and page (integers). Each offer carries its id and its pipeline_template_id (for list_offer_stages). |
list_stage_candidates | List the candidates currently in one pipeline stage of an offer, as placements (placement id, candidate_id, candidate, stage_id). offer_id = offer id or slug (from list_offers), stage_id = stage id (from list_offer_stages). Optional: qualified / disqualified (booleans), limit (1-1000, default 20), page. The placement id is the placement_id of move_candidate_stage. |
list_tags | List the candidate tags of the company. Optional: query (search), sort_by (“name” or “taggings_count”), sort_order (“asc” default, or “desc”). |
