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
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:
| Provider | fieldsComplete | Extracted Fields & Questions | Submission Path |
|---|---|---|---|
| Greenhouse | true | Full application fields, custom questions, EEOC surveys, file uploads | Greenhouse API application endpoint |
| Ashby | true | Full posting questions, custom screening fields, resume/file uploads | Ashby submission API |
| Lever | true | Standard candidate fields + custom screening questions | Direct apply URL |
| Rippling | true | Basic candidate contact fields + custom board questions | Direct apply URL |
| Recruitee | true | Full application fields, custom open questions, choice options, resume & cover letter attachments | Direct apply URL |
| SmartRecruiters | false | Standard applicant questions + dynamic job-specific apply URL | Job-specific apply URL |
| Workable | false | Standard applicant questions + direct apply path | Job-specific apply URL |
| BambooHR | false | Standard applicant contact & resume fields | Career opening share URL |
| Pinpoint | false | Standard candidate & resume fields | Direct /applications/new endpoint |
| JazzHR | false | Standard candidate & resume fields | Direct applytojob URL |
| Breezy HR | false | Standard candidate & resume fields | Direct apply URL (/p/:id/apply) |
| Personio | false | Standard candidate & resume fields | Career portal job anchor (#apply) |
| Teamtailor | false | Standard candidate & resume fields | Direct posting URL / job apply path |
| Homerun | false | Standard candidate & resume fields | Direct posting URL / careers site |
| Workday | false | Standard candidate & resume fields | Direct /job/:id/apply URL |
| iCIMS | false | Standard candidate & resume fields | Direct apply mode URL (?mode=apply) |
| SAP SuccessFactors | false | Standard candidate & resume fields | Direct career portal job link |
| Oracle Taleo | false | Standard candidate & resume fields | Direct CareerSection job detail link |
Usage Patterns
1. Direct Adapter
If you are using a specific adapter directly:
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():
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:
| Section | Description | Examples |
|---|---|---|
personal | Basic applicant contact info | Name, Email, Phone, Location |
links | Profile and portfolio URLs | LinkedIn, GitHub, Website |
experience | Past work and career history | Previous employer, Years of experience |
education | Degree and academic history | University, Degree, Graduation year |
skills | Technical and domain competencies | Programming languages, certifications |
screening | Company-specific role questions | "Why do you want to work here?", notice period |
legal | Authorization and compliance | Visa sponsorship, non-compete agreements |
references | Professional references | Reference contact details |
eeoc | Voluntary demographic surveys | Gender, race/ethnicity, veteran status |
attachments | File documents | Resume, Cover letter, Portfolio |
other | Uncategorized custom inputs | Miscellaneous 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.
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.