Yardstick ATS

Preview an unsaved workflow rule (runs nothing) — Preview a rule before saving it, for a real application: the same result as preview-rule. Pass the rule as you would to create (CLI: --body-json '{"rule":{...}}'); add rule_id to preview unsaved edits to that rule. Saves nothing and executes no action.

Check a draft job posting for problems — Validate a draft job posting without mutating it.

Replace the offer's documents with a different packet. If answers or edits would be lost, nothing changes until you confirm. — Replace the offer's documents with a different packet. If answers or edits would be lost, nothing changes and the call returns a 409 `change_packet_confirm_required` error with the number of answers and edits. To go ahead, repeat the call with `confirm_drops` set to true.

Edit one document for this offer only. The library document does not change. — Edit one document for this offer only. The library document does not change. `expected_draft_revision` is required.

List the documents in an offer and what each still needs before sending. — List the documents in an offer and what each still needs before sending.

Remove a document from a draft offer. — Remove a document from a draft offer.

Set the order of the documents in a draft offer. List every document once. — Set the order of the documents in a draft offer. List every document once.

Archive an offer document. Admins only. — Archive an offer document. Admins only.

Copy an offer document into a new draft. Admins only. — Copy an offer document into a new draft. Admins only.

Create an offer document. Admins only. — Create an offer document. Admins only.

List offer documents with their fill-ins, packets and published version. Admins only. — List offer documents with their fill-ins, packets and published version. Admins only.

Publish the current draft as a new version. Admins only. — Publish the current draft as a new version. Admins only.

Read an offer document, its draft and its versions. Admins only. — Read an offer document, its draft and its versions. Admins only.

Save an offer document draft and its fill-ins. Admins only. — Save an offer document draft and its fill-ins. Admins only.

Archive an offer packet. Admins only. — Archive an offer packet. Admins only.

Create an offer packet. Admins only. — Create an offer packet. Admins only.

List offer packets and their documents. Admins only. — List offer packets and their documents. Admins only.

Set the order of offer packets. Admins only. — Set the order of offer packets. Admins only.

Change an offer packet. Admins only. — Change an offer packet. Admins only.

Download one signed file of an offer as a PDF. Requires creator or admin access. — Download one signed file of an offer as a PDF. file_id is required: this tool returns one file per call, up to 3 MB. Get the IDs from `yardstick_offers_signed_files_list`. For a larger file, or to save every file, use the CLI `yardstick offers signed-files download`. Requires creator or admin access.

List the signed files of an offer. Requires creator or admin access. — List the signed files of an offer. Requires creator or admin access.

Add competencies to an interview plan draft — Add competencies to a draft exactly as written — deterministic, no AI generation. Requires confirmed outcomes; the resulting stage must stay within 25 competencies. Optional source_stage {stage: competencies, version} returns 409 when stale.

Confirm draft hiring outcomes — Confirm draft interview-plan outcomes before generating later stages.

Generate draft scorecard anchors — Generate scorecard behavioral anchors (levels 1-4) for each draft competency, or one competency when competency_id is supplied.

Generate draft competencies — Generate draft interview-plan competencies from confirmed outcomes.

Generate draft hiring outcomes — Generate draft interview-plan outcomes from explicit role context, or pass accepted_outcomes to store caller-written outcomes verbatim with no AI generation (the deterministic draft bootstrap).

Generate draft questions and interviewer directions — Generate interview questions and interviewer/candidate directions for each draft round, or one round when round_id is supplied.

Generate draft interview rounds — Generate draft interview-plan rounds from confirmed skills.

Generate draft job skills — Generate draft interview-plan skills from confirmed competencies.

List interview plan drafts — List interview-plan drafts, newest first. Optional job_id narrows the list to one job and takes a job_ public display id. Use this to find an ipd_ draft id again after an interrupted builder session.

Read an interview plan draft — Read one interview-plan draft in full: every stage checkpoint (outcomes, competencies, job skills, interview sequence, questions and directions), stage_versions for source_stage preconditions, status, and source metadata. Question ids are always present (question_N fallback), so edits can target them directly.

Archive an interview plan — Archive one interview plan. Already-archived plans succeed without a write. A plan still attached to a job is refused — detach it from the job first.

List published interview plans — List published interview plans, newest first. Optional job_id narrows the list to one job and takes a job_ public display id. Use this to find an interview plan id when you only hold a job id.

Read a published interview plan — Read one interview plan by public id.

Set whether the hiring manager decides a step — Turn on or off whether a plan step waits on the hiring manager's decision before the candidate moves on. Only workflow managers on an open job can change it.

Restore an archived interview plan — Restore one archived interview plan. Plans that are already live succeed without a write. If the plan's job has since acquired another live plan, the restore is refused and names that plan.

Confirm and archive a job posting — Bind an already-previewed job-posting archive with explicit approval metadata and matching idempotency key.

Preview archiving a job posting (nothing changed yet) — Preview job-posting archive approval requirements only; bind fields are rejected.

Create a draft job posting — Create a draft job posting through the public Yardstick API.

Confirm and publish a job posting — Bind an already-previewed job-posting publish with explicit approval metadata and matching idempotency key.

Preview publishing a job posting (nothing changed yet) — Preview job-posting publish approval requirements only; bind fields are rejected.

Update a job posting — Update a job posting with schema-bound public API fields.

Read the approval step assigned to you. — Read the approval step assigned to you.

Cancel a replacement draft. — Cancel a replacement draft.

Read company signature settings for this offer. — Read company signature settings for this offer.

Configure the company signer. This does not sign the offer. — Configure the company signer. This does not sign the offer.

Create an offer draft. — Create an offer draft.

Read offer reminder settings. Admin only. — Read offer reminder settings. Admin only.

Set reminder intervals in seconds before expiry. Admin only. — Set reminder intervals in seconds before expiry. Admin only.

List offers visible to you. — List offers visible to you.

Open a replacement draft. Sending requires a separate preview and confirmation. — Open a replacement draft. Sending requires a separate preview and confirmation.

Read an offer. Members see status; its creator and admins see full details. — Read an offer. Members see status; its creator and admins see full details.

Confirm offer rescind — Withdraw only the offer explicitly reviewed in preview.

Preview offer rescind — Review withdrawal and optional candidate email without changing the offer.

Confirm offer send — Send only the exact offer explicitly reviewed in preview.

Preview offer send — Review the exact offer and recipient without sending.

Read offer delivery status and recovery guidance. — Read offer delivery status and recovery guidance.

Get a five-minute download link for the signed company copy. Requires creator or admin access. — Get a five-minute download link for the signed company copy. Requires creator or admin access.

Read signing, company signature, finalization and lifecycle status. — Read signing, company signature, finalization and lifecycle status.

Request approval of this draft. — Request approval of this draft.

Read the offer history. — Read the offer history.

Update a draft using its current version. — Update a draft using its current version.

Read candidate email verification settings. Admin only. — Read candidate email verification settings. Admin only.

Set candidate email verification requirements. Admin only. — Set candidate email verification requirements. Admin only.

Add questions to a draft interview round — Add questions to one draft round exactly as written — deterministic, no AI generation. Requires rounds; each round holds at most 50 questions. The first question edit on a round persists question_N ids for every question in that round. Optional source_stage {stage: questions_and_directions, version} returns 409 when stale.

Add interview rounds to an interview plan draft — Add interview rounds to a draft exactly as written — deterministic, no AI generation. Requires skills; the resulting sequence must stay within 20 rounds. Optional source_stage {stage: interview_sequence, version} returns 409 when stale.

Add job skills to an interview plan draft — Add job skills to a draft exactly as written — deterministic, no AI generation. Requires competencies; the resulting stage must stay within 50 skills. Optional source_stage {stage: skills, version} returns 409 when stale.

Clear all draft competencies, leaving the section empty — Clear every competency from a draft, leaving the stage deliberately empty — deterministic, no AI generation. Prunes the behavioral anchors of every cleared competency in the same write and reports the pruned ids. The emptied draft cannot be published as a new plan; bind the emptying onto an already-live plan with modify_active. Optional source_stage {stage: competencies, version} returns 409 when stale.

Clear all draft interview rounds, leaving the section empty — Clear every interview round from a draft, leaving the stage deliberately empty — deterministic, no AI generation. Prunes the questions and directions of every cleared round in the same write and reports the pruned round ids. The emptied draft cannot be published as a new plan; bind the emptying onto an already-live plan with modify_active. Optional source_stage {stage: interview_sequence, version} returns 409 when stale.

Clear all draft job skills, leaving the section empty — Clear every job skill from a draft, leaving the stage deliberately empty — deterministic, no AI generation. The item delete refuses to remove the last skill, so this is the only way to record that the section was addressed and left empty. The emptied draft cannot be published as a new plan; bind the emptying onto an already-live plan with modify_active. Optional source_stage {stage: skills, version} returns 409 when stale.

Clear all draft outcomes, leaving the section empty — Clear every outcome from a draft, leaving the stage deliberately empty — deterministic, no AI generation. Outcomes have no item-level delete, and confirm_outcomes requires at least one outcome, so this is the only way to record that the section was addressed and left empty. The emptied draft cannot be published as a new plan; bind the emptying onto an already-live plan with modify_active. Optional source_stage {stage: outcomes, version} returns 409 when stale.

Delete draft scorecard anchors — Delete behavioral-anchor entries for draft items by item id. Optional source_stage {stage: questions_and_directions, version} returns 409 when stale.

Delete draft competencies — Delete draft competencies by id. Prunes each deleted competency's behavioral anchors in the same write and reports the pruned ids; the stage must keep at least one competency. Optional source_stage {stage: competencies, version} returns 409 when stale.

Delete questions from a draft interview round — Delete questions from one draft round by question id. Optional source_stage {stage: questions_and_directions, version} returns 409 when stale.

Delete draft interview rounds — Delete draft interview rounds by id. Prunes each deleted round's questions and directions in the same write and reports the pruned ids; the sequence must keep at least one round. Optional source_stage {stage: interview_sequence, version} returns 409 when stale.

Delete draft job skills — Delete draft job skills by id; the stage must keep at least one skill. Optional source_stage {stage: skills, version} returns 409 when stale.

Set draft scorecard anchors — Upsert behavioral anchors for draft items, keyed by item id with levels 1-4 — deterministic, no AI generation. Requires competencies; anchors keyed to unknown item ids are rejected by id. Optional source_stage {stage: questions_and_directions, version} returns 409 when stale.

Rewrite or reorder draft competencies — Replace draft competencies by id and/or reorder them with order (a complete permutation of resulting ids) — deterministic, no AI generation. Updating in place keeps the item id. Optional source_stage {stage: competencies, version} returns 409 when stale.

Rewrite or reorder a draft round's questions — Replace one draft round's questions by id and/or reorder them with order (a complete permutation of that round's resulting question ids) — deterministic, no AI generation. Read the draft first: stored questions expose stable question_N ids. Optional source_stage {stage: questions_and_directions, version} returns 409 when stale.

Set a draft round's interviewer and candidate directions — Set one draft round's interviewer and/or candidate directions exactly as written — deterministic, no AI generation. Provide at least one of the two direction fields. Optional source_stage {stage: questions_and_directions, version} returns 409 when stale.

Rewrite or reorder draft interview rounds — Replace draft interview rounds by id and/or reorder them with order (a complete permutation of resulting ids) — deterministic, no AI generation. A round updated in place keeps its id, so its questions and directions are preserved (not pruned). Optional source_stage {stage: interview_sequence, version} returns 409 when stale.

Rewrite or reorder draft job skills — Replace draft job skills by id and/or reorder them with order (a complete permutation of resulting ids) — deterministic, no AI generation. Optional source_stage {stage: skills, version} returns 409 when stale.

Check an interview plan draft for problems — Validate an interview-plan draft without publishing it.

Confirm and edit a live interview plan — Bind an already-previewed interview-plan active modification with explicit approval metadata and matching idempotency key.

Preview editing a live interview plan (nothing changed yet) — Preview interview-plan active-modification approval requirements only; bind fields are rejected.

Confirm and publish an interview plan — Bind an already-previewed interview-plan publish with explicit approval metadata and matching idempotency key.

Preview publishing an interview plan (nothing changed yet) — Preview interview-plan publish approval requirements only; bind fields are rejected.

Read an interview — Read one interview session by public id.

Decide a hiring manager step — Advance or hold a candidate on a step that waits on the hiring manager, or change that decision. The hiring manager or a recruiter on the job may decide. Leave out interview_id to decide the latest such step. A note can go to the recruiter with send_to_recruiter.

Read the hiring manager decision — Read where the hiring manager's decision stands on the candidate's latest step that waits on one: advanced, held, waiting, or none.

Set whether the hiring manager decides a step — Turn on or off whether a plan step waits on the hiring manager's decision before the candidate moves on. Only workflow managers on an open job can change it.

List members assignable as interviewers — List organization members who can be assigned as interviewers, newest membership first. Use this to pick a usr_ public display id before assigning an interviewer.

Assign an interviewer to an interview — Assign an interviewer to an interview session. Email notification is attempted by default; set notify_interviewer to false to opt out. The response reports the safe interviewer_email outcome.

List interviewers on an interview — List interviewers assigned to an interview session.

Decide on an application — Decide on an application without a review task. Only the job's hiring manager may decide. Reject disqualifies the candidate.

Confirm bulk automation rule changes — Switch rules on, off or delete them. First use mode=preview with rule_ids or filter. Show the affected rules and skipped rules to the user and get explicit confirmation BEFORE applying. Then use mode=apply with only the exact rule_ids returned by preview; never reapply the filter. Pick a step rules are skipped when switching on. Warn that shared pipeline rules change for every job on that pipeline, including jobs outside the filter.

Copy a rule to jobs or pipelines — Copy one hiring process rule to job_ids, or one pipeline rule to pipeline_ids. Matches steps by name or kind and position, stages by name or mapped status. Unmatched copies start off and require Pick a step or Pick a stage. Copies are independent user rules.

Copy automations into a job — Copy reviewed rules into a job using chosen matches; keep unmatched rules off and existing rules intact.

Create an automation starter — Create a named organization starter from portable rule definitions.

Delete an automation starter — Delete an organization starter while keeping existing job copies.

List automation starters — List your organization’s saved automation starters.

Preview copying automations into a job — Preview copying a starter or job’s rules, including step and stage matches and unmatched rules.

Rename an automation starter — Rename an organization starter without changing existing job copies.

Save job automations as a starter — Save a job’s automation rules as a named organization starter.

Create a custom email — create an email. Use email_type for a built-in type or custom template key.

Delete a custom email — delete an email. Use email_type for a built-in type or custom template key.

Duplicate an email — duplicate an email. Use email_type for a built-in type or custom template key.

Reset an email to its Yardstick default — reset an email. Use email_type for a built-in type or custom template key.

Preview assigning a hiring pipeline to a job — Preview the job's stages in use, candidate counts and suggested same-name mapping before changing its pipeline. Makes no changes.

Answer an assigned review task — Answer an assigned application or scorecard review. Recruiter questions require a note.

List audit log entries — List public Yardstick audit log entries visible to the current principal.

List API events — List public Yardstick API events visible to the current principal.

Cancel a scheduled interview — Cancel a scheduled interview session, releasing the provider booking and invalidating its scheduling links.

Complete an interview — Complete an interview session for an explicit interviewer.

Remove an interviewer from an interview — Unassign an interviewer from an interview session.

Check interview scheduling readiness — Read interview-session scheduling readiness.

Generate a candidate scheduling link — Generate a scheduling link for an interview session.

Submit an interview scorecard — Submit an interview-session scorecard with explicit ratings.

Start an interview — Start an interview session for an explicit interviewer.

Move an application to Candidates — Move one reviewed application to Candidates. Does not schedule interviews or send email.

Undo an accidental move to Candidates — Correct one accidental candidate admission using its current admission ID. No time limit; refused once candidate activity starts. Preserves history and excludes the corrected episode from admission reporting.

Preview a saved workflow rule (runs nothing) — Preview a saved workflow rule for a real application: recipients, sender, rendered email, scheduling links and missing prerequisites. Executes no action.

Try a workflow run again after fixing setup — Try a workflow run again after fixing missing setup. Only clean refusals and active rules qualify; unknown outcomes are refused.

Clone a hiring pipeline — Clone a pipeline and its stages. Set copy_rules to copy its workflow rules too (requires automation_rules:write). Returns rules_copied.