{ "openapi": "3.0.1", "info": { "title": "Career Site Jobs API: Greenhouse, Lever, Ashby, SmartRecruiters", "description": "Job postings API for company career sites on Greenhouse, Lever, Ashby and SmartRecruiters. Get salary ranges, location, remote flag and full descriptions from 8,500+ verified companies. Filter by title, location and date. Incremental mode returns only new or changed jobs. $2 per 1,000 jobs.", "version": "0.1", "x-build-id": "Zph1rQVzniIAPT1Oz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magenta_waterwheel~career-site-jobs-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magenta_waterwheel-career-site-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/magenta_waterwheel~career-site-jobs-api/runs": { "post": { "operationId": "runs-sync-magenta_waterwheel-career-site-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/magenta_waterwheel~career-site-jobs-api/run-sync": { "post": { "operationId": "run-sync-magenta_waterwheel-career-site-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", "properties": { "companies": { "title": "Companies", "type": "array", "description": "One company per line. Use \"ats:token\" (for example greenhouse:airbnb, lever:palantir, lever-eu:token, ashby:ramp, smartrecruiters:BoschGroup) or paste a career-page URL such as https://job-boards.greenhouse.io/airbnb, https://jobs.lever.co/palantir, https://jobs.ashbyhq.com/ramp or https://jobs.smartrecruiters.com/BoschGroup.", "items": { "type": "string" } }, "useSeedList": { "title": "Use built-in company list", "type": "boolean", "description": "Also scrape the built-in list of 8,500+ verified companies with active job boards (Greenhouse, Ashby, SmartRecruiters and Lever). Combine with keyword and location filters to search across many employers at once.", "default": false }, "seedAts": { "title": "ATS platforms in built-in list", "type": "array", "description": "Limit the built-in list to these platforms. Leave empty for all.", "items": { "type": "string", "enum": [ "greenhouse", "lever", "ashby", "smartrecruiters" ], "enumTitles": [ "Greenhouse", "Lever", "Ashby", "SmartRecruiters" ] }, "default": [] }, "maxSeedCompanies": { "title": "Max companies from built-in list", "minimum": 0, "type": "integer", "description": "Use at most this many companies from the built-in list (largest boards first). 0 means no limit.", "default": 0 }, "keywords": { "title": "Title keywords", "type": "array", "description": "Keep jobs whose title contains any of these words or phrases (case-insensitive). Leave empty to keep all jobs.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude title keywords", "type": "array", "description": "Drop jobs whose title contains any of these words (case-insensitive), for example \"intern\" or \"senior\".", "default": [], "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Keep jobs whose location contains any of these strings (case-insensitive), for example \"New York\", \"London\", \"Germany\" or \"Remote\".", "default": [], "items": { "type": "string" } }, "remoteOnly": { "title": "Remote jobs only", "type": "boolean", "description": "Keep only jobs marked as remote by the ATS or with \"remote\" in the location.", "default": false }, "postedWithinDays": { "title": "Posted within (days)", "minimum": 0, "type": "integer", "description": "Keep only jobs posted or updated in the last N days. 0 means no date filter.", "default": 0 }, "descriptionFormat": { "title": "Job description format", "enum": [ "text", "html", "both", "none" ], "type": "string", "description": "How to return the job description. \"Plain text\" is best for AI and search; \"None\" makes runs faster and output smaller.", "default": "text" }, "maxJobs": { "title": "Max jobs", "minimum": 0, "type": "integer", "description": "Stop after this many jobs have been saved. 0 means no limit (the run still stops at your maximum cost per run).", "default": 0 }, "incrementalMode": { "title": "Incremental mode (only new or changed jobs)", "type": "boolean", "description": "Remember jobs between runs and output only jobs that are new or whose title, location, salary or description changed since the last run. Ideal for scheduled runs. The first run returns all jobs as NEW.", "default": false }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Name of the key-value store that keeps incremental state. Use a different name for each monitoring task (for example one per filter set).", "default": "career-site-jobs-state" }, "outputRemovedJobs": { "title": "Output removed jobs", "type": "boolean", "description": "In incremental mode, also output jobs that disappeared since the last run, marked with changeType REMOVED. These are billed like other results.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many company boards to fetch in parallel.", "default": 10 }, "maxRequestRetries": { "title": "Max retries per company", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a company board after a network error or server error. A board that does not exist (HTTP 404) is not retried.", "default": 3 } } }, "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 } } } } } } } } } }