{ "openapi": "3.0.1", "info": { "title": "ATS Jobs Scraper: Greenhouse, Lever, Ashby & More", "description": "Fetch all open jobs from a company's career board on Greenhouse, Lever, Ashby, Workable, or SmartRecruiters using the official public job-board JSON APIs.", "version": "0.1", "x-build-id": "qm1AujLWUCjlN4Oda" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zerahdata~ats-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zerahdata-ats-jobs-scraper", "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/zerahdata~ats-jobs-scraper/runs": { "post": { "operationId": "runs-sync-zerahdata-ats-jobs-scraper", "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/zerahdata~ats-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-zerahdata-ats-jobs-scraper", "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", "properties": { "startUrls": { "title": "Career board URLs", "type": "array", "description": "Career board URLs to scrape, e.g. https://boards.greenhouse.io/airbnb, https://jobs.lever.co/spotify, https://jobs.ashbyhq.com/ramp, https://apply.workable.com/huzzle, https://jobs.smartrecruiters.com/McDonaldsCorporation. The platform is auto-detected from the URL.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "companies": { "title": "Companies (platform + slug)", "type": "array", "description": "Optional alternative to Career board URLs: a list of { \"platform\": \"greenhouse\"|\"lever\"|\"ashby\"|\"workable\"|\"smartrecruiters\", \"slug\": \"company-slug\" } objects.", "default": [] }, "companyNames": { "title": "Company names/slugs (auto-detect platform)", "type": "array", "description": "Optional alternative when you don't know which ATS a company uses: a list of plain company slugs, e.g. \"airbnb\". For each one, the actor tries Greenhouse, Lever, Ashby, Workable, then SmartRecruiters in order and uses the first platform that responds.", "default": [], "items": { "type": "string" } }, "keyword": { "title": "Keyword filter (title)", "type": "string", "description": "Only keep jobs whose title contains one of these words/phrases (case-insensitive). Separate multiple keywords with a comma for OR matching, e.g. \"engineer, designer\". Leave empty for no filter.", "default": "" }, "location": { "title": "Location filter", "type": "string", "description": "Only keep jobs whose location text contains this string (case-insensitive). Leave empty for no filter.", "default": "" }, "remoteOnly": { "title": "Remote only", "type": "boolean", "description": "Only keep jobs that are flagged as remote by the job board.", "default": false }, "maxJobsPerCompany": { "title": "Max jobs per company", "minimum": 0, "type": "integer", "description": "Maximum number of jobs to fetch per company. Set to 0 for unlimited (fetch all open jobs).", "default": 5 }, "includeDescription": { "title": "Include job description", "type": "boolean", "description": "When enabled (default), each job includes descriptionText (plain text) and descriptionHtml. Disable to omit description fields and produce a lighter dataset.", "default": true }, "postedWithinDays": { "title": "Posted within days", "minimum": 0, "type": "integer", "description": "Only keep jobs posted/updated within this many days. Set to 0 to disable (keep all jobs regardless of posting date). Jobs without a known posting date are always kept.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy configuration. Not required for these public JSON APIs, but can help if a board starts rate-limiting your IP.", "default": { "useApifyProxy": false } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of companies to scrape in parallel.", "default": 5 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "type": "integer", "description": "Optional delay in milliseconds between consecutive paginated requests to the same company, to be polite to the public API.", "default": 0 }, "trackChanges": { "title": "Track new/closed jobs between runs", "type": "boolean", "description": "When enabled, the actor remembers which job IDs it has seen per company (in a named key-value store) and on every run after the first tags each job with isNew/firstSeenAt, and emits a \"change\" row for every previously-seen job that disappeared (closed). Combine with a schedule for a daily hiring-change feed.", "default": false }, "monitorName": { "title": "Monitor name (key-value store)", "type": "string", "description": "Name of the key-value store used to persist seen-job state when \"Track new/closed jobs\" is on. Use the same name across scheduled runs of the same project; use different names to keep multiple monitors independent. Leave empty to use the default \"ats-jobs-monitor\" store.", "default": "" }, "outputMode": { "title": "Output mode (when tracking changes)", "enum": [ "all", "newOnly" ], "type": "string", "description": "\"all\": push every matching job every run (default). \"newOnly\": only push jobs that are new since the last run (isNew: true) - closed-job \"change\" rows and the company summary are still pushed either way. Ignored unless \"Track new/closed jobs\" is on.", "default": "all" }, "includeCompanySummary": { "title": "Include per-company hiring summary", "type": "boolean", "description": "When enabled (default), each company also gets one extra \"companySummary\" row: open-roles count, breakdown by department and location, remote share, salary-transparency share, median salary (where available), and new-this-run count (when tracking changes). Charged as a single result row, same as a job row.", "default": true } } }, "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 } } } } } } } } } }