{
  "openapi": "3.0.1",
  "info": {
    "title": "ATS Jobs API - Workday, Greenhouse, Lever, Ashby job scraper",
    "description": "Extract every public job posting from company career pages. Auto-detects Workday, Greenhouse, Lever, Ashby, SmartRecruiters, Workable and Recruitee, normalizes jobs to one schema (salary, location, remote, Markdown description) and flags new / updated / closed jobs between runs.",
    "version": "1.0",
    "x-build-id": "Lhf3lvvDRBtVzR1cj"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/beguiling_equator~ats-jobs-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-beguiling_equator-ats-jobs-api",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/beguiling_equator~ats-jobs-api/runs": {
      "post": {
        "operationId": "runs-sync-beguiling_equator-ats-jobs-api",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/beguiling_equator~ats-jobs-api/run-sync": {
      "post": {
        "operationId": "run-sync-beguiling_equator-ats-jobs-api",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "companies"
        ],
        "properties": {
          "companies": {
            "title": "Companies (URLs, domains or ats:slug)",
            "minItems": 1,
            "uniqueItems": true,
            "type": "array",
            "description": "One entry per company. Accepted forms: a careers URL on a supported ATS (https://boards.greenhouse.io/gitlab, https://jobs.lever.co/palantir, https://jobs.ashbyhq.com/ashby, https://jobs.smartrecruiters.com/BoschGroup, https://apply.workable.com/blueground, https://bunq.recruitee.com, https://nvidia.wd5.myworkdayjobs.com/NVIDIAExternalCareerSite); an explicit pair like greenhouse:gitlab or lever:palantir; or a bare company domain such as gitlab.com (auto-detected by scanning the careers page and probing the vendor APIs - this is the only form that triggers the company-detected charge).",
            "items": {
              "type": "string"
            }
          },
          "ats": {
            "title": "ATS",
            "enum": [
              "auto",
              "greenhouse",
              "lever",
              "ashby",
              "smartrecruiters",
              "workable",
              "recruitee",
              "workday"
            ],
            "type": "string",
            "description": "Force one ATS for every entry (useful when you pass bare slugs). Leave on Auto to detect per company.",
            "default": "auto"
          },
          "maxJobsPerCompany": {
            "title": "Max jobs per company",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many jobs per company (0 = all). Applies before filters. When a board is truncated, 'closed' detection is skipped for it in that run.",
            "default": 0
          },
          "includeDescription": {
            "title": "Include job descriptions",
            "type": "boolean",
            "description": "Fetch the full description (Markdown + plain text). For Workday and SmartRecruiters this costs one extra request per job; turn it off for fast title/location-only monitoring.",
            "default": true
          },
          "includeRaw": {
            "title": "Include raw vendor fields",
            "type": "boolean",
            "description": "Attach the untouched vendor JSON under `raw` (bigger dataset items).",
            "default": true
          },
          "keywords": {
            "title": "Title keywords",
            "type": "array",
            "description": "Keep only jobs whose title, department or team contains any of these words (case-insensitive). Example: engineer, data, sales.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Keep only jobs whose location contains any of these strings (case-insensitive), e.g. London, Remote, United States.",
            "items": {
              "type": "string"
            }
          },
          "remoteOnly": {
            "title": "Remote only",
            "type": "boolean",
            "description": "Keep only jobs flagged remote by the ATS or whose location/title says remote.",
            "default": false
          },
          "postedAfter": {
            "title": "Posted after (ISO date)",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}",
            "type": "string",
            "description": "Keep only jobs posted on or after this date (YYYY-MM-DD). Jobs with an unknown posting date are kept."
          },
          "detectChanges": {
            "title": "Detect changes between runs",
            "type": "boolean",
            "description": "Compare with the previous run (fingerprints stored in a named key-value store) and label every job new / updated / unchanged, plus emit closed jobs that disappeared.",
            "default": true
          },
          "emitUnchanged": {
            "title": "Output unchanged jobs",
            "type": "boolean",
            "description": "When off, only new and updated jobs are written (and charged). Great for daily monitors.",
            "default": true
          },
          "emitClosed": {
            "title": "Output closed jobs",
            "type": "boolean",
            "description": "Write a small record with change = closed for every job that was present last run and is gone now (never charged).",
            "default": true
          },
          "stateStoreName": {
            "title": "State store name",
            "type": "string",
            "description": "Name of the key-value store holding fingerprints and the detection cache. Use different names for independent monitors.",
            "default": "ats-jobs-api-state"
          },
          "detectionCacheDays": {
            "title": "Detection cache (days)",
            "minimum": 0,
            "type": "integer",
            "description": "How long an auto-detected ATS mapping for a domain is reused before probing again (0 = always re-detect).",
            "default": 7
          },
          "maxConcurrencyPerHost": {
            "title": "Max concurrent requests per host",
            "minimum": 1,
            "maximum": 4,
            "type": "integer",
            "description": "Parallel requests to a single host (1-4).",
            "default": 2
          },
          "requestsPerSecondPerHost": {
            "title": "Requests per second per host",
            "minimum": 1,
            "maximum": 2,
            "type": "integer",
            "description": "Upper bound 2 (hard cap). Lower it for very sensitive hosts.",
            "default": 2
          },
          "maxCompaniesInParallel": {
            "title": "Companies processed in parallel",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many companies are fetched at the same time (1-10). Per-host limits still apply.",
            "default": 3
          },
          "maxRetries": {
            "title": "Max retries",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Retries for 429/5xx/network errors with exponential backoff (0-5). After that the board is skipped with a warning.",
            "default": 3
          },
          "maxSecondsPerCompany": {
            "title": "Time budget per company (seconds)",
            "minimum": 10,
            "maximum": 3000,
            "type": "integer",
            "description": "Hard cap on how long one company board may take (10-3000). A board that is still running when the budget ends is cut off with a warning; the jobs fetched until then are kept and the other companies continue. Raise it for very large Workday / SmartRecruiters boards with descriptions on (one request per job).",
            "default": 180
          },
          "robotsPolicy": {
            "title": "robots.txt policy",
            "enum": [
              "vendor-api",
              "strict"
            ],
            "type": "string",
            "description": "vendor-api (default): robots.txt is enforced for company websites and Workday hosts; the documented public JSON APIs of Greenhouse, Lever, Ashby, SmartRecruiters, Workable and Recruitee follow their vendor API terms instead. strict: enforce robots.txt on every host (this disables SmartRecruiters, whose API host disallows all crawlers).",
            "default": "vendor-api"
          },
          "recruiteeCareersSiteToken": {
            "title": "Recruitee Careers Site token (optional)",
            "type": "string",
            "description": "Recruitee announced that from 2027-02-10 the offers endpoint requires an X-Careers-Sites-Token. Paste yours here when that happens; not needed today."
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}