Yardstick ATS

List application person + Job attachments visible to the current principal. Filter by --job-id to find candidates for a role, and by --hiring-manager-decision (advanced, held or waiting) for where the hiring manager's decision stands.

Read one application person + Job attachment by public id.

Bind the fixed applications-owned status/email approval POC with explicit approval metadata and a matching idempotency key.

Preview the fixed applications-owned Interviewing to Offer status/email approval POC without mutating status or email state.

Bind an already-previewed application transition with explicit approval metadata and matching idempotency key.

Directly write a non-terminal application transition; approval-only statuses are rejected. Optionally target a configured stage by id with pipeline_stage_id (the resolved stage is reported back).

Preview approval-required application transitions only; bind fields and direct-write targets are rejected. Optionally target a configured stage by id with pipeline_stage_id (status must match the stage's mapped status).

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.

Update one application with schema-bound public API fields.

Apply an approved ATS import preview with a preview_hash matching the stored dry-run. Creates people/jobs/interview_plans(stub)/job_postings/applications with idempotent replay; never sends outreach, merges people, or deletes records.

Preview a structured-row ATS import of candidates, jobs, and applications (source_kind: csv). JSON rows only; no raw CSV/archive file reads, no application conversion side effects, and low-confidence stage/fuzzy matches require explicit apply decisions.

Read one ATS import dry-run/apply batch and its rows by public id.

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

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 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.

Create a named workflow automation rule with stage or step triggers, job scope, delivery mode, timing and a typed action. Authoring executes no action.

Delete an automation rule. Plain delete (no approval preview→bind): rules are inert config, so deleting unfired config moves no candidates.

List all job and pipeline rules. Filter by job_id (null for pipeline rules), department_id, pipeline_id, trigger, email or is_active. Job and department filters include inherited pipeline rules; pipeline filters also include hiring-step rules on jobs using that pipeline.

Dry-run preview: resolve the active rules + their resolved action params for a sample application entering/leaving a stage. INERT — mints no scheduling link, creates no task, sends no email; executes 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.

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

Read one automation rule by public id (its trigger, typed action, target stage, and is_active state).

Edit a workflow automation rule's name, stage or step trigger, action, condition, job scope, delivery mode, timing or active state.

List workflow automation runs including public_state, reason, next_action, due_at and interview_session_id. Filter by application-id or rule-id. Read-only; runs are system-written.

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

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

Create a named organization starter from portable rule definitions.

Delete an organization starter while keeping existing job copies.

List your organization’s saved automation starters.

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

Rename an organization starter without changing existing job copies.

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

Bind an approved built-in-agent configure preview (same config plus approval metadata and a matching idempotency key). Writes only the built-in agent's declared settings keys and records one audit row.

Preview configuring a built-in agent (config is validated against the built-in agent's declared schema; enabled is a first-class key, so { enabled: false } is the off switch). Side-effect free; pass config via --body-json.

Bind an approved built-in-agent enable preview with explicit approval metadata and a matching idempotency key. Writes the built-in agent's declared settings home and records one audit row.

Preview enabling a built-in agent; returns the approval-required envelope stating exactly what starts happening (and what is never sent without you) plus binding fields. Side-effect free.

List the built-in-agent catalog with each built-in agent's current status, explicit defaults or disabled state, and latest work summary.

Read one built-in agent by catalog id (for example scorecard-chaser, nightly-screening, or interview-kit-prep): what it does, what it never does without you, current status, and latest work summary.

List the organization's built-in-agent run history as a flat work report. Nightly screening reports scheduled-work counts and held, released, or invalidated review outputs; interview-kit preparation reports the scheduled week and count-only results. It never includes candidate, draft, recipient, kit, or provider details. delivery_unknown is not delivered and is not retried. Filterable by built-in-agent id. Read-only and mode-scoped.

Read the decision brief for an application.

Regenerate a decision brief for an application with idempotency metadata.

Create a Department through the public Yardstick API.

Create a Department-scoped invitation without returning token material.

List redacted Department invitation views.

List Departments visible to the current principal.

Add an existing person to a Department.

List Department members for an authorized Department.

Remove a Department member, optionally with a replacement lead.

Set one Department member as lead.

Read one Department by public id.

Update one Department with schema-bound public API fields.

Read candidate email automation settings.

Update candidate email automation settings.

Discard a pending candidate email draft without provider mutation.

Read candidate email draft history and provenance.

List candidate email drafts with optional status and email-type filters.

Read rendered preview content for a candidate email draft.

Read a redacted candidate email draft.

Send a pending candidate email draft with replay protection, or reclaim a never-delivered draft and send it.

Save mutable candidate email draft fields or set/clear a validated sender override.

List redacted sender provider connection state.

List candidate email sender defaults.

Set the default sender policy for a candidate email type.

Read redacted email sender settings with sanitized queue diagnostics.

List immutable email versions.

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

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

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

List Candidate and Internal emails with automation usage counts.

Preview an email for sample variables.

Preview AI sample customization for an email without publishing.

Update, create, duplicate, reset or delete an email. Set operation; custom emails use email_type as their template key.

Read an email by built-in type or custom template key.

reset an email. Use email_type for a built-in type or custom template key.

Restore an email to an immutable version.

Validate email subject, HTML, and text bodies.

List public Yardstick API events visible to the current principal.

Record direct final-recommendation evidence; this does not mutate application status.

Return the current Yardstick API principal context.

Read sanitized Workspace integration health diagnostics.

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.

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 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 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 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 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 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 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.

Confirm draft interview-plan outcomes before generating later stages.

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 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 one draft round by question id. Optional source_stage {stage: questions_and_directions, version} returns 409 when stale.

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 by id; the stage must keep at least one skill. Optional source_stage {stage: skills, version} returns 409 when stale.

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

Generate draft interview-plan competencies from confirmed 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 interview questions and interviewer/candidate directions for each draft round, or one round when round_id is supplied.

Generate draft interview-plan rounds from confirmed skills.

Generate draft interview-plan skills from confirmed competencies.

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 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.

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.

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.

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 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.

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.

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.

Validate an interview-plan draft without publishing it.

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, 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.

Bind an already-previewed interview-plan active modification with explicit approval metadata and matching idempotency key.

Preview interview-plan active-modification approval requirements only; bind fields are rejected.

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

Preview interview-plan publish approval requirements only; bind fields are rejected.

Read one interview plan by public id.

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 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.

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.

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

Complete an interview session for an explicit interviewer.

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 assigned to an interview session.

Unassign an interviewer from an interview session.

Read one interview session by public id.

Read interview-session scheduling readiness.

Generate a scheduling link for an interview session.

Submit an interview-session scorecard with explicit ratings.

Start an interview session for an explicit interviewer.

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

Preview job-posting archive approval requirements only; bind fields are rejected.

Create a draft job posting through the public Yardstick API.

List job postings visible to the current principal.

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

Preview job-posting publish approval requirements only; bind fields are rejected.

Read one job posting by public id.

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

Validate a draft job posting without mutating it.

Archive one Job row only; linked job postings, applications, and interview plans are not mutated.

Link an existing interview plan, job posting, or application to a Job. Idempotent when already linked to the same Job; conflicts when linked elsewhere. Requires jobs:write and the artifact's own write scope.

Close one Job row only; linked job postings, applications, and interview plans are not mutated.

Create an internal Job container without mutating job postings, applications, or interview plans.

Clear the link between an artifact and a Job. Idempotent when already unlinked. Requires jobs:write and the artifact's own write scope.

List internal Job containers visible to the current principal.

List deterministic Talent CRM prospect matches for one Job. Read-only; includes evidence, caveats, and blocked lifecycle states without outreach, conversion, import, or AI ranking.

Read one internal Job container by public id.

Update one internal Job container with schema-bound public API fields.

Fill in the answers the offer documents ask for. `expected_draft_revision` is required.

Record only the approval decision explicitly reviewed in preview.

Review an approval decision without recording it.

Read the approval step assigned to you.

Cancel a replacement draft.

Read company signature settings for this offer.

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

Create an offer draft.

Add a published offer document to a draft offer.

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. `expected_draft_revision` is required.

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

Remove a document from a draft offer.

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

Archive an offer document. Admins only.

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

Create an offer document. 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.

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

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

Archive an offer packet. Admins only.

Create an offer packet. Admins only.

List offer packets and their documents. Admins only.

Set the order of offer packets. Admins only.

Change an offer packet. Admins only.

Read offer reminder settings. Admin only.

Set reminder intervals in seconds before expiry. Admin only.

List offers visible to you.

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

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

Withdraw only the offer explicitly reviewed in preview.

Review withdrawal and optional candidate email without changing the offer.

Send only the exact offer explicitly reviewed in preview.

Review the exact offer and recipient without sending.

Read offer delivery status and recovery guidance.

Get a five-minute download link for the signed company copy. 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.

Read signing, company signature, finalization and lifecycle status.

Request approval of this draft.

Read the offer history.

Update a draft using its current version.

Read candidate email verification settings. Admin only.

Set candidate email verification requirements. Admin only.

Create a public deep link for an opportunity workflow view.

List read-only opportunity workflow views visible to the current principal.

Read the next action state for an opportunity without mutating it.

Read one read-only opportunity workflow view by public id.

Create a person through the public Yardstick API.

Mint a signed download URL for one person document. Read-only. The URL expires in 5 minutes and is a bearer link: do not log or share it. Takes per_ and pdoc_ display ids.

List the documents attached to a person (resumes and other files). Archived documents are excluded unless include_archived is true. Takes a per_ display id and returns pdoc_ display ids.

List people visible to the current principal. Pass email to find the exact person behind a candidate_email_conflict.

Read one person by public id.

Update one person with schema-bound public API fields.

Assign a pipeline to a job (jobs.pipeline_template_id) or clear it with pipeline_id: null. Pipeline validated by org; job resolved by org+mode.

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

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

Create a custom pipeline template with optional inline stages. Does not affect the org default pipeline or candidate tracking.

List the organization's pipeline templates with their ordered stages. Canonical default stages are flagged canonical_locked.

Read one pipeline template and its ordered stages by public id.

Reorder all stages of a pipeline by supplying the complete stage id order. Constraint-safe; allowed for canonical stages.

Append (or insert at a position) a stage to a pipeline with a kind and optional approval scope.

Bind an approved pipeline-stage delete with explicit approval metadata and a matching idempotency key. Refuses while candidates remain.

Preview deleting a pipeline stage; returns the candidate-count impact and binding fields. Canonical default stages are rejected.

Edit a pipeline stage. Canonical default stages allow display-name change only; slug/stage_kind/approval_scope/is_terminal are locked.

Rename, re-describe, or toggle active for one pipeline template.

Create a bounded internal prospect activity note or touchpoint.

List bounded activity records for one Talent CRM prospect.

Apply an approved Prospect CRM import preview with preview_hash and explicit row decisions for advisory matches.

Preview a structured-row Prospect CRM import. JSON rows only; no raw CSV/resume file reads, outreach, application conversion, source ranking, or silent person merge.

Read one Prospect CRM import dry-run/apply batch by public id.

Bind an approved prospect conversion preview with explicit approval metadata and matching idempotency key.

Preview conversion of one Prospect into one canonical Application; bind fields are rejected and no outreach/import/merge occurs.

Create Talent CRM prospect relationship state for an existing person.

List active Talent CRM prospects visible to the current principal.

Create a pending review prospect outreach email draft. Sending stays on email draft send and requires communications:send.

Preview a one-off prospect outreach draft without creating a draft, sending email, enrolling a sequence, or creating an application.

Read one Talent CRM prospect by public id.

Update bounded Talent CRM prospect relationship fields.

Search redacted recruiting reporting summaries through the public reporting API.

Create an opaque source/referral link for a published job posting. Raw source_token is returned only in the create response; reads return token_hint, and active token-bearing links also return public_url.

Disable a source/referral link so its public URL no longer stamps attribution.

List source/referral attribution links without raw token material or source quality ranking.

Read one source/referral attribution link by public id without raw token material.

Add an existing prospect to a Talent CRM pool.

List active prospect memberships for one Talent CRM pool.

Remove an active prospect membership from a Talent CRM pool.

Create a Talent CRM pool.

List Talent CRM pools visible to the current principal. Archived pools are excluded unless include_archived is true.

Read one Talent CRM pool by public id.

Update bounded Talent CRM pool fields.

Search all authorized recruiting records by literal keywords across names, notes, activities and current parsed résumés. All words must match; PhD punctuation is normalized.

Create a public task deep link for a caller-supplied task id.

List Yardstick tasks visible to the current principal.

Answer an assigned application or scorecard review. Recruiter questions require a note; send_to_recruiter shares a scorecard note with the recruiter.