Docs
HiringMay change state

Prepare Ats Export

prepare_ats_export

Prepare selected submitted application materials for a specific Greenhouse job, with explicit name mapping and optional explicitly selected existing candidate ID. Private applicant context and recruiter notes are excluded. Applicant approve_ats_disclosure review is required before recruiter approve_ats_delivery review. No applicant data is sent externally by preparation.

Source-catalog reference. Discover the live server’s tools before calling. An annotation does not replace authorization or exact review requirements.

Parameters

NameContract
job_id
Required
string
application_id
Required
string
destination_job_id
Required
integer
first_name
Required
string
last_name
Required
string
existing_candidate_id
Optional
integer
include_resume
Required
boolean
include_cover_note
Required
boolean
include_answers
Required
boolean

Exact input schema

Expand JSON Schema
{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "job_id": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9_-]{1,100}$"
    },
    "application_id": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9_-]{1,100}$"
    },
    "destination_job_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "first_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "last_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "existing_candidate_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "include_resume": {
      "type": "boolean"
    },
    "include_cover_note": {
      "type": "boolean"
    },
    "include_answers": {
      "type": "boolean"
    }
  },
  "required": [
    "job_id",
    "application_id",
    "destination_job_id",
    "first_name",
    "last_name",
    "include_resume",
    "include_cover_note",
    "include_answers"
  ],
  "additionalProperties": false
}

Output schema

Expand output contract
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^[a-zA-Z0-9_-]{1,100}$"
        },
        "state": {
          "type": "string",
          "const": "prepared"
        },
        "next_action": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "state",
        "next_action"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Tool annotations

{
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true
}

← All hiring tools · Review and receipts