API Reference
Deep-dive into ATS SDK's core methods, classes, and options.
This page provides detailed interface definitions for the primary exports of ats-sdk.
For the data structures returned by the SDK (like StandardJob), refer to the Schema documentation.
Client Methods
createAtsClient(config: AtsClientConfig)
Creates a unified ATS Client capable of aggregating multiple companies seamlessly. It relies on the Auto-Discovery engine to automatically detect and cache the ATS provider for each company identifier.
AtsClientConfig
Prop
Type
Returns: AtsClient
import { createAtsClient } from "ats-sdk";
const ats = createAtsClient({ companies: ["stripe"] });
const { jobs, total } = await ats.getJobs();company(identifier: string)
A lazy helper that wraps a single company identifier in an AtsAdapter. It delays resolving the ATS until the first API call is made.
Parameters
identifier(string): A company slug, brand name, or career page URL.
Returns: CompanyAdapter (implements AtsAdapter)
import { company } from "ats-sdk";
const stripe = company("stripe");
const { jobs } = await stripe.getJobs();AtsAdapter.getForm(jobId: string, options?: GetFormOptions)
Fetches and normalizes the job application form, custom questions, input types, and submission paths for a specific job posting.
Parameters
jobId(string): The job posting identifier.options(GetFormOptions, optional): Configuration such assignalfor request cancellation.
Returns: Promise<AtsFormResult>
import { greenhouse } from "ats-sdk/greenhouse";
const adapter = greenhouse({ boardToken: "stripe" });
const form = await adapter.getForm("6141315");
console.log(`Extracted ${form.fields.length} questions`);AtsAdapter.submitApplication(jobId: string, submission: AtsApplicationSubmission, options?: SubmitApplicationOptions)
Submits a candidate application directly to the ATS public API (or returns browser automation requirements for web-only ATS platforms).
Parameters
jobId(string): The job posting identifier (or deterministic ID likegh-stripe-123).submission(AtsApplicationSubmission): Candidate profile details, resume attachment, answers, and optional EEO demographic data.options(SubmitApplicationOptions, optional): Configuration such asdryRun: trueandsignal.
Returns: Promise<AtsSubmitApplicationResult>
import { greenhouse } from "ats-sdk/greenhouse";
const adapter = greenhouse({ boardToken: "stripe" });
const result = await adapter.submitApplication(
"6141315",
{
candidate: {
firstName: "Jane",
lastName: "Doe",
email: "jane.doe@example.com",
},
resume: {
filename: "resume.pdf",
data: resumeBuffer,
},
},
{ dryRun: true }
);
console.log(result.status); // "dry_run"Core Types
GetJobsOptions
Options used by AtsClient.getJobs() and AtsAdapter.getJobs() to filter and limit the results.
Prop
Type
GetFormOptions
Options passed into AtsAdapter.getForm(jobId, options).
Prop
Type
SubmitApplicationOptions
Options passed into submitApplication(jobId, submission, options).
Prop
Type
AtsApplicationSubmission
The payload representing candidate information, resume attachment, custom answers, and voluntary EEO disclosures.
Prop
Type
AtsSubmitApplicationResult
The standardized result returned after an application submission or dry-run validation.
Prop
Type
AtsAdapter
The standard interface that all 18 integrations (Greenhouse, Lever, Ashby, etc.) strictly implement.
Prop
Type
GetJobsResult
The standardized payload returned when fetching jobs from any adapter.
Prop
Type
AtsFormResult
The standardized payload returned when retrieving an application form.
Prop
Type
Diagnostic Methods
AtsClient.doctor()
Iterates through all provided company identifiers, attempts to resolve their ATS, and probes their endpoints to measure latency and structural validity.
Returns: Promise<AtsDoctorResult[]>
Prop
Type
Discovery & Utilities
detectAts(identifier: string, options?: DetectAtsOptions)
The underlying autonomous discovery engine. Resolves an unknown company identifier into a concrete ATS provider and board token.
Parameters
identifier: A company slug, brand name, or career page URL.options:signal:AbortSignalskipCache:boolean(Default:false)skipProbe:boolean(Default:false. Iftrue, avoids firing live API tests.)
Returns: Promise<AtsDetectionResult>
Prop
Type