{ "openapi": "3.0.1", "info": { "title": "ATS Jobs Scraper & API: Workday, Greenhouse, Lever, Ashby", "description": "Scrape jobs straight from company career sites: Workday, Greenhouse, Lever, Ashby, SmartRecruiters, Recruitee, Personio, Workable. Give company names or domains: the Actor finds the career site. Salary per year, remote filter, only new jobs, full description.", "version": "0.1", "x-build-id": "YYYlLdmg9Z3e5dkzs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s_actors~ats-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s_actors-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/s_actors~ats-jobs-scraper/runs": { "post": { "operationId": "runs-sync-s_actors-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/s_actors~ats-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-s_actors-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": { "companies": { "title": "🏢 Companies", "type": "array", "description": "One per line: a company name (\"Airbnb\", \"Delivery Hero\"), a domain (\"notion.so\"), a career-site link (boards.greenhouse.io/stripe, jobs.lever.co/spotify, jobs.ashbyhq.com/ramp, nvidia.wd5.myworkdayjobs.com/NVIDIAExternalCareerSite) or \"ats:slug\" (\"greenhouse:stripe\", \"workday:accenture.wd103/AccentureCareers\"). The Actor finds the ATS of a name or a domain by itself.", "items": { "type": "string" } }, "atsPlatforms": { "title": "🧩 ATS platforms", "type": "array", "description": "Look for the career site only on these platforms. Empty = all eight.", "items": { "type": "string", "enum": [ "greenhouse", "lever", "ashby", "workday", "smartrecruiters", "recruitee", "personio", "workable" ], "enumTitles": [ "Greenhouse", "Lever", "Ashby", "Workday", "SmartRecruiters", "Recruitee", "Personio", "Workable" ] } }, "titleKeywords": { "title": "🔍 Job title keywords", "type": "array", "description": "Keep jobs whose title contains one of these (case-insensitive): \"data engineer\", \"nurse\", \"sales\". Empty = every job of the company.", "items": { "type": "string" } }, "titleExclude": { "title": "❌ Title must not contain", "type": "array", "description": "Skip jobs whose title contains one of these words, e.g. \"intern\", \"director\".", "items": { "type": "string" } }, "locations": { "title": "📍 Locations", "type": "array", "description": "Keep jobs whose location text contains one of these: \"Berlin\", \"Germany\", \"Remote\", \"CA\". Case-insensitive.", "items": { "type": "string" } }, "workplaceTypes": { "title": "🏠 Remote, hybrid or on-site", "type": "array", "description": "Keep only these. Taken from the ATS when it has the field (Ashby, Lever), else from the title, location and description.", "items": { "type": "string", "enum": [ "remote", "hybrid", "on-site" ], "enumTitles": [ "Remote", "Hybrid", "On-site" ] } }, "employmentTypes": { "title": "📄 Employment type", "type": "array", "description": "Keep only these (when the ATS states the type).", "items": { "type": "string", "enum": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary" ], "enumTitles": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary" ] } }, "departments": { "title": "🗂️ Department contains", "type": "array", "description": "Keep jobs whose department or team contains one of these: \"Engineering\", \"Sales\".", "items": { "type": "string" } }, "postedWithinDays": { "title": "🕒 Posted within (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only jobs published in the last N days. Workday gives the date only as \"N days ago\" (30+ is kept as 30 days)." }, "onlyWithSalary": { "title": "💲 Only jobs with salary", "type": "boolean", "description": "Only jobs whose pay range is in the ATS data or the description.", "default": false }, "minYearlySalary": { "title": "💰 Min yearly salary", "minimum": 0, "type": "integer", "description": "Only jobs whose pay range reaches this amount per year, in the job's own currency. Implies \"Only jobs with salary\"." }, "maxJobsPerCompany": { "title": "🔢 Max jobs per company", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Per company and ATS board. Big Workday boards hold thousands of jobs.", "default": 200 }, "skipDuplicates": { "title": "♻️ Skip reposts", "type": "boolean", "description": "A job with the same title, company and location as one already in the results is skipped and not charged.", "default": true }, "onlyNewJobs": { "title": "🔔 Only new jobs (job alerts)", "type": "boolean", "description": "Return only jobs not returned by earlier runs with the same monitor name. The first run returns the current jobs. Jobs seen before are free.", "default": false }, "monitorName": { "title": "🏷️ Monitor name", "type": "string", "description": "Separate job alert lists: runs with the same name share the jobs already seen.", "default": "default" }, "descriptionFormat": { "title": "📝 Job description", "enum": [ "text", "html", "both", "none" ], "type": "string", "description": "Format of the full job description. \"None\" skips the extra request per job that Workday and SmartRecruiters need for it (their salary and remote filters use it too).", "default": "text" }, "maxConcurrency": { "title": "⚙️ Parallel requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many requests run at once.", "default": 10 }, "proxyConfiguration": { "title": "🌐 Proxy", "type": "object", "description": "Career sites are public and need no proxy: it is used only to retry a request that was refused.", "default": { "useApifyProxy": true } }, "debugLog": { "title": "🐞 Debug log", "type": "boolean", "description": "Log every failed attempt.", "default": false } } }, "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 } } } } } } } } } }