{ "openapi": "3.0.1", "info": { "title": "ATS Jobs API - Greenhouse, Lever, Ashby, Workable | $1.50/1K", "description": "Give it company names, not board tokens. Finds each company's job board across 6 applicant tracking systems and returns every opening in one schema - normalised country, remote flag, salary. Pay per job; companies it cannot find are free.", "version": "0.1", "x-build-id": "JohrdUACsFEn1Gu1y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northwestsouth~ats-job-board-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northwestsouth-ats-job-board-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/northwestsouth~ats-job-board-scraper/runs": { "post": { "operationId": "runs-sync-northwestsouth-ats-job-board-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/northwestsouth~ats-job-board-scraper/run-sync": { "post": { "operationId": "run-sync-northwestsouth-ats-job-board-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", "required": [ "companies" ], "properties": { "companies": { "title": "Companies", "type": "array", "description": "Company names (\"GetYourGuide\"), domains (\"raisin.com\") or an exact board if you know it (\"greenhouse:gitlab\", \"personio:acme\"). Names and domains are resolved automatically — you do not need to know which HR system a company uses. Companies that cannot be located cost nothing.", "default": [ "GetYourGuide", "raisin.com", "Staffbase", "forto", "greenhouse:gitlab" ], "items": { "type": "string" } }, "atsPlatforms": { "title": "Only search these systems (optional)", "type": "array", "description": "Leave empty to try all seven. Restricting the list makes discovery faster and cheaper when you already know the platform.", "items": { "type": "string", "enum": [ "greenhouse", "lever", "ashby", "smartrecruiters", "recruitee", "workable", "personio" ], "enumTitles": [ "Greenhouse", "Lever", "Ashby", "SmartRecruiters", "Recruitee", "Workable", "Personio (DACH)" ] }, "default": [] }, "countries": { "title": "Country filter (ISO codes)", "type": "array", "description": "e.g. DE, AT, CH. Locations are normalised, so \"Berlin\", \"München\" and \"Remote Germany\" all resolve to DE. Leave empty for every country.", "default": [], "items": { "type": "string" } }, "titleKeywords": { "title": "Job title must contain one of", "type": "array", "description": "Case-insensitive, e.g. engineer, entwickler, sales. Leave empty for all titles.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip titles containing", "type": "array", "description": "e.g. intern, praktikum, working student.", "default": [], "items": { "type": "string" } }, "departments": { "title": "Department or team contains", "type": "array", "description": "Matched against both department and team, e.g. engineering, marketing.", "default": [], "items": { "type": "string" } }, "remoteOnly": { "title": "Remote positions only", "type": "boolean", "description": "Uses the platform's own remote flag where it exists, and the location text otherwise.", "default": false }, "postedWithinDays": { "title": "Posted within the last N days", "minimum": 1, "type": "integer", "description": "Leave empty for all. Jobs with no publication date are excluded when this is set." }, "onlyNewJobs": { "title": "Only jobs I have not seen before", "type": "boolean", "description": "For monitoring. Jobs already returned by an earlier run of this actor are skipped and NOT charged again, so a daily schedule only pays for genuinely new postings.", "default": false }, "includeDescription": { "title": "Include full job description", "type": "boolean", "description": "Adds description_html and description_text. Slower, and much larger output. SmartRecruiters needs one extra request per job for this, capped at 200.", "default": false }, "maxJobsPerCompany": { "title": "Max jobs per company", "minimum": 1, "type": "integer", "description": "Leave empty for all openings." }, "maxJobs": { "title": "Max jobs in total", "minimum": 1, "type": "integer", "description": "A hard ceiling on the run, and therefore on the cost." }, "discoverViaCareersPage": { "title": "Fall back to reading the careers page", "type": "boolean", "description": "ON by default. When token discovery finds nothing and you supplied a domain, the careers page is checked for a board link. Reads static HTML only.", "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 } } }, "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 } } } } } } } } } }