Agent Careerats-sdk

Application Forms

Extract job application questions, field requirements, and submission endpoints with getForm().

AI career agents and job application pipelines need to know more than just the job description—they need the exact application form questions, file attachment requirements, custom screening prompts, and submission paths before directing or assisting a candidate.

ATS SDK provides a standardized getForm(jobId) method across supported ATS adapters that normalizes form fields, input types, and sections into a single predictable structure.

Quick Example

form.ts
import { greenhouse } from "ats-sdk/greenhouse";

const adapter = greenhouse({ boardToken: "stripe" });

// Retrieve the application form for a specific job
const form = await adapter.getForm("1234567");

console.log(`Provider: ${form.provider}`);
console.log(`Fields Complete: ${form.fieldsComplete}`);
console.log(`Found ${form.fields.length} application questions:`);

for (const field of form.fields) {
  const req = field.required ? "(Required)" : "(Optional)";
  console.log(`[${field.section}] ${field.label} [${field.type}] ${req}`);
  if (field.options?.length) {
    console.log(`  Options: ${field.options.join(", ")}`);
  }
}

Supported Providers

ATS SDK provides tiered support for application form extraction depending on what upstream ATS APIs expose publicly:

ProviderfieldsCompleteExtracted Fields & QuestionsSubmission Path
GreenhousetrueFull application fields, custom questions, EEOC surveys, file uploadsGreenhouse API application endpoint
AshbytrueFull posting questions, custom screening fields, resume/file uploadsAshby submission API
LevertrueStandard candidate fields + custom screening questionsDirect apply URL
RipplingtrueBasic candidate contact fields + custom board questionsDirect apply URL
RecruiteetrueFull application fields, custom open questions, choice options, resume & cover letter attachmentsDirect apply URL
SmartRecruitersfalseStandard applicant questions + dynamic job-specific apply URLJob-specific apply URL
WorkablefalseStandard applicant questions + direct apply pathJob-specific apply URL
BambooHRfalseStandard applicant contact & resume fieldsCareer opening share URL
PinpointfalseStandard candidate & resume fieldsDirect /applications/new endpoint
JazzHRfalseStandard candidate & resume fieldsDirect applytojob URL
Breezy HRfalseStandard candidate & resume fieldsDirect apply URL (/p/:id/apply)
PersoniofalseStandard candidate & resume fieldsCareer portal job anchor (#apply)
TeamtailorfalseStandard candidate & resume fieldsDirect posting URL / job apply path
HomerunfalseStandard candidate & resume fieldsDirect posting URL / careers site
WorkdayfalseStandard candidate & resume fieldsDirect /job/:id/apply URL
iCIMSfalseStandard candidate & resume fieldsDirect apply mode URL (?mode=apply)
SAP SuccessFactorsfalseStandard candidate & resume fieldsDirect career portal job link
Oracle TaleofalseStandard candidate & resume fieldsDirect CareerSection job detail link

Usage Patterns

1. Direct Adapter

If you are using a specific adapter directly:

rippling-form.ts
import { rippling } from "ats-sdk/rippling";

const adapter = rippling({ boardToken: "rippling" });
const form = await adapter.getForm("75ad50c6-778f-42ee-9c63-70d1cd687202");

// Inspect screening questions
const screeningQuestions = form.fields.filter((f) => f.section === "screening");

2. Auto-Discovery & Lazy Adapter

You can also call getForm() using the lazy company() adapter or resolving via createAtsClient():

company-form.ts
import { company } from "ats-sdk";

const stripe = company("stripe");
const form = await stripe.getForm("6141315");

Form Schemas

AtsFormResult

The canonical payload returned by adapter.getForm(jobId).

Prop

Type

AtsFormField

Each element in form.fields represents an individual input or question on the application form.

Prop

Type


Form Field Classification

Input Types (FormFieldType)

Every field is normalized to a known input primitive:

  • "text": Single-line string input (e.g. First Name, Phone).
  • "textarea": Multi-line text responses (e.g. Cover Letter text, open questions).
  • "select": Single-choice dropdown or selection menu.
  • "multiselect": Multiple-choice selection.
  • "checkbox": Boolean toggle or confirmation checkbox.
  • "radio": Radio button choice card.
  • "file": Document upload (e.g. Resume PDF, Portfolio, Transcript).
  • "date": Date picker / ISO date string input.

Form Sections (FormFieldSection)

Questions are categorized automatically into standardized sections so agents can group and auto-fill related questions:

SectionDescriptionExamples
personalBasic applicant contact infoName, Email, Phone, Location
linksProfile and portfolio URLsLinkedIn, GitHub, Website
experiencePast work and career historyPrevious employer, Years of experience
educationDegree and academic historyUniversity, Degree, Graduation year
skillsTechnical and domain competenciesProgramming languages, certifications
screeningCompany-specific role questions"Why do you want to work here?", notice period
legalAuthorization and complianceVisa sponsorship, non-compete agreements
referencesProfessional referencesReference contact details
eeocVoluntary demographic surveysGender, race/ethnicity, veteran status
attachmentsFile documentsResume, Cover letter, Portfolio
otherUncategorized custom inputsMiscellaneous inputs

Form Fingerprinting & Change Detection

AtsFormResult includes a deterministic fingerprint property. This is a computed hash based on the names, types, and requirements of all fields.

fingerprint.ts
const form = await adapter.getForm("12345");

// Store fingerprint in your database alongside the job posting
await db.jobPostings.update({
  where: { id: "12345" },
  data: {
    formFingerprint: form.fingerprint,
    formLastChecked: new Date(),
  },
});

// Easily detect if application requirements changed:
if (storedFingerprint !== form.fingerprint) {
  console.log("Application questions were updated by the employer!");
}

Next Steps

Once you have extracted and populated an application form, submit it directly via the API:

  • Direct Submissions Guide — Learn how to submit candidate profiles, validate attachments with dryRun, and handle browser automation fallbacks.

On this page