Yardstick ATS

Return the current Yardstick API principal context.

List Yardstick tasks visible to the current principal.

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

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

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.

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.

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.

Create a person through the public Yardstick API.

Update one person with schema-bound public API 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.

List active Talent CRM prospects visible to the current principal.

Read one Talent CRM prospect by public id.

Create Talent CRM prospect relationship state for an existing person.

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

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

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

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

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.

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

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.

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.

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.

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.

Update bounded Talent CRM prospect relationship fields.

List bounded activity records for one Talent CRM prospect.

Create a bounded internal prospect activity note or touchpoint.

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.

Create a Talent CRM pool.

Update bounded Talent CRM pool fields.

List active prospect memberships for one Talent CRM pool.

Add an existing prospect to a Talent CRM pool.

Remove an active prospect membership from a Talent CRM pool.

List application person + Job attachments visible to the current principal. Filter by --job-id to find candidates for a role.

Read one application person + Job attachment by public id.

Create a recruiter or agent-sourced application for an existing person and job posting.

Update one application with schema-bound public API fields.

Decide on an application without a review task. Only the job's hiring manager may decide; anyone else gets application not found. Reason codes must be system codes or your organization's. Reject disqualifies the candidate.

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

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.

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

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

Preview application archive approval requirements only; bind fields are rejected.

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

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

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

Read the decision brief for an application.

Regenerate a decision brief for an application with idempotency metadata.

Preview the candidate email decision for an application status change without mutating the application or drafts.

Apply an application status-change email decision with idempotency metadata.

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

Read a redacted candidate email draft.

Read rendered preview content for a candidate email draft.

Read candidate email draft history and provenance.

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

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

Discard a pending candidate email draft without provider mutation.

Read candidate email automation settings.

Update candidate email automation settings.

Read redacted email sender settings with sanitized queue diagnostics.

List redacted sender provider connection state.

List candidate email sender defaults.

Read sanitized Workspace integration health diagnostics.

Set the default sender policy for a candidate email type.

List Candidate and Internal emails with automation usage counts.

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

Preview an email for sample variables.

Validate email subject, HTML, and text bodies.

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

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

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

List immutable email versions.

Restore an email to an immutable version.

Preview AI sample customization for an email without publishing.

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

List interview sessions for an application.

Ensure an application interview session for an explicit round id.

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

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

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

Create a public deep link for an opportunity workflow view.

Search redacted recruiting reporting summaries through the public reporting API.

List Departments visible to the current principal.

Read one Department by public id.

Create a Department through the public Yardstick API.

Update one Department with schema-bound public API fields.

List Department members for an authorized Department.

Add an existing person to a Department.

Set one Department member as lead.

Remove a Department member, optionally with a replacement lead.

List redacted Department invitation views.

Create a Department-scoped invitation without returning token material.

List explicit access grants visible to the current principal.

Read one explicit access grant by public id.

Create a reasoned, revocable, audited access grant.

Revoke an explicit access grant with optional reason text.

List internal Job containers visible to the current principal.

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

Read one internal Job container by public id.

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.

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

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

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.

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

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.

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

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

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

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

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

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

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

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

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.

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.

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.

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

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

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.

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

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

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

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

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

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.

List your organization’s saved automation starters.

Create a named organization starter from portable rule definitions.

Rename an organization starter without changing existing job copies.

Delete an organization starter while keeping existing job copies.

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

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

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

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-

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.

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

List job postings visible to the current principal.

Read one job posting by public id.

Validate a draft job posting without mutating it.

Create a draft job posting through the public Yardstick API.

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

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

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

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

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

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 one interview plan by public id.

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.

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.

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

Confirm draft interview-plan outcomes before generating later stages.

Generate draft interview-plan competencies from confirmed outcomes.

Generate draft interview-plan skills from confirmed competencies.

Generate draft interview-plan rounds from confirmed skills.

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

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

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.

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.

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.

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.

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.

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.

Delete draft job skills by id; the stage must keep at least one skill. Optional source_stage {stage: skills, 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.

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.

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.

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.

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.

Delete questions from one draft round by question id. 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.

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.

Delete behavioral-anchor entries for draft items by item id. Optional source_stage {stage: questions_and_directions, 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

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

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

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}

Validate an interview-plan draft without publishing it.

Preview interview-plan publish 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 active-modification approval requirements only; bind fields are rejected.

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

Read one interview session by public id.

List interviewers assigned to an interview session.

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 session. Email notification is attempted by default; set notify_interviewer to false to opt out. The response reports the safe interviewer_email outcome.