Agent Careerats-sdk

Universal Schema

TypeScript definitions and normalization rules for StandardJob.

ATS SDK normalizes raw provider responses into a canonical, opinionated StandardJob object.

Type Definition

schema.ts
export type AtsProvider =
  | "greenhouse"
  | "ashby"
  | "lever"
  | "workday"
  | "smartrecruiters"
  | "workable"
  | "recruitee"
  | "breezy"
  | "bamboohr"
  | "rippling"
  | "personio";

export type Workplace = "remote" | "hybrid" | "onsite" | "unknown";

export type EmploymentType =
  "full-time" | "part-time" | "contract" | "internship";

Prop

Type

Normalization Guarantees

  1. Provider-Agnostic Source Object: The source field explicitly identifies { provider, id }, making cross-ATS aggregation clean and indexable.
  2. Deterministic Workplace Classification: Automatic parsing of remote, hybrid, and onsite tags in titles, locations, and metadata into lowercase enum values (remote, hybrid, onsite, or unknown).
  3. Structured Compensation: Normalizes salary ranges into salaryMin, salaryMax, salaryCurrency, and salaryInterval alongside human-readable salary.
  4. Lossless raw payload: The complete upstream API response is always preserved on job.raw for custom field extraction.

Application Form Schema

When extracting questions and application requirements via getForm(jobId), ATS SDK normalizes form structures into AtsFormResult and AtsFormField.

See the Application Forms guide for comprehensive usage details.

AtsFormResult

Prop

Type

AtsFormField

Prop

Type

On this page