{ "openapi": "3.0.1", "info": { "title": "ATS Jobs Scraper & API: Greenhouse, Lever, Ashby, Workday", "description": "Company names in, live jobs out: finds each company's own board on 9 ATS platforms (Greenhouse, Lever, Ashby, Workday...), returns postings as one clean schema with salary/location/seniority, or emits only what opened, closed or changed since the last run. Employer-published data, no LinkedIn.", "version": "0.1", "x-build-id": "wagq21H9tPNo7cCgc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/friendlyapi~ats-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-friendlyapi-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/friendlyapi~ats-jobs-scraper/runs": { "post": { "operationId": "runs-sync-friendlyapi-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/friendlyapi~ats-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-friendlyapi-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", "required": [ "mode", "companies" ], "properties": { "mode": { "title": "Mode", "enum": [ "find_board", "fetch_jobs", "watch_changes" ], "type": "string", "description": "find_board = which ATS a company uses, with evidence; fetch_jobs = live normalized postings for your companies; watch_changes = only what opened/closed/changed since the last run with the same watch_id", "default": "fetch_jobs" }, "companies": { "title": "Companies", "type": "array", "description": "One entry per company: a name (\"Ramp\"), a domain (\"ramp.com\", more precise), or a job-board URL (\"https://jobs.lever.co/plaid\", exact; the only way to reach Workday tenants). Objects work too: {\"company\": \"Ramp\", \"domain\": \"ramp.com\", \"id\": \"my-key\"}. Up to 500 for find_board/watch_changes, 200 for fetch_jobs." }, "watch_id": { "title": "Watch ID (watch_changes mode)", "type": "string", "description": "Stable name for this watch list, e.g. 'competitor-watch'. It names the stored snapshot the next run diffs against. The first run with a new watch_id sets the baseline and emits no events; schedule the actor and later runs emit only real changes." }, "include_descriptions": { "title": "Include job descriptions", "type": "boolean", "description": "Full description text per job (plain text, cleaned). Default ON for fetch_jobs. Default OFF for watch_changes: leaner, faster, and title/location/salary/team changes are still detected. Keep it consistent between watch runs, changing it mid-watch makes one run report every description as changed.", "default": true }, "include_html": { "title": "Include raw HTML descriptions", "type": "boolean", "description": "Also keep the employer's original HTML description alongside the cleaned text (fetch_jobs mode).", "default": false }, "max_jobs_per_company": { "title": "Max jobs per company", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap per company in fetch_jobs mode. Large enterprises list thousands.", "default": 1000 }, "read_careers_page": { "title": "Read the company's careers page", "type": "boolean", "description": "During discovery, also read the company's own public careers page to confirm the board and to find Workday tenants (their board URLs cannot be guessed from a name). Turn off only if you want pure API probing.", "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 } } } } } } } } } }