{ "openapi": "3.0.1", "info": { "title": "Company Career Jobs API: Greenhouse, Lever, Ashby & more", "version": "0.1", "x-build-id": "rQ1RbAxB6BPdUWcKb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/volanta-ai~company-career-jobs-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-volanta-ai-company-career-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/volanta-ai~company-career-jobs-api/runs": { "post": { "operationId": "runs-sync-volanta-ai-company-career-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/volanta-ai~company-career-jobs-api/run-sync": { "post": { "operationId": "run-sync-volanta-ai-company-career-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", "required": [ "companies" ], "properties": { "companies": { "title": "Companies", "minItems": 1, "type": "array", "description": "One company per line (up to 1,000 per run; the Apify Free plan demo checks the first 10). Accepted forms: an ATS board URL (https://boards.greenhouse.io/stripe, https://jobs.lever.co/palantir, https://jobs.ashbyhq.com/ramp, https://apply.workable.com/huggingface, https://bunq.recruitee.com, https://jobs.smartrecruiters.com/Ubisoft2, https://tado.jobs.personio.de), a careers page URL, a company domain (ramp.com), or a slug/name (stripe, Hugging Face). Board URLs are the fastest and most precise; domains and names are auto-detected.", "items": { "type": "string" } }, "atsHint": { "title": "ATS (optional)", "enum": [ "auto", "greenhouse", "lever", "ashby", "workable", "recruitee", "smartrecruiters", "personio" ], "type": "string", "description": "Force one ATS when your entries are slugs, names or domains. Leave on auto-detect unless a company is detected on the wrong system. Ignored for ATS board URLs.", "default": "auto" }, "titleKeywords": { "title": "Job title keywords (include)", "type": "array", "description": "Keep jobs whose title contains ANY of these words or phrases (case-insensitive, whole words: \"engineer\" matches \"Senior Engineer\" but not \"Engineering Manager\"). End a keyword with * for prefix matching (\"engineer*\"). Leave empty to keep all titles.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Job title keywords (exclude)", "type": "array", "description": "Drop jobs whose title contains ANY of these words or phrases (same matching rules as the include list), e.g. \"intern\", \"senior\".", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Keep jobs where any job location contains ANY of these texts (case-insensitive substring), e.g. \"Berlin\", \"United Kingdom\", \"NY\". The value \"remote\" also matches jobs whose workplace type is remote.", "items": { "type": "string" } }, "remoteOnly": { "title": "Remote jobs only", "type": "boolean", "description": "Keep only jobs marked remote by the ATS or with \"Remote\" in a location.", "default": false }, "departments": { "title": "Departments or teams", "type": "array", "description": "Keep jobs whose department or team contains ANY of these texts (case-insensitive substring), e.g. \"Engineering\", \"Sales\".", "items": { "type": "string" } }, "postedWithinDays": { "title": "Posted within (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Keep jobs first published in the last N days (by the ATS posting date). 0 = no limit. Jobs without a known posting date are dropped when this is set.", "default": 0 }, "includeDescription": { "title": "Job description", "enum": [ "text", "html", "both", "none" ], "type": "string", "description": "Include the job description as plain text, sanitized HTML, both, or not at all (smaller, faster output). Emails and phone numbers are redacted from descriptions on a best-effort basis.", "default": "text" }, "maxJobsPerCompany": { "title": "Max jobs per company", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Deliver at most this many matching jobs per company (most recently posted first). 0 = no limit. On the Apify Free plan the demo returns at most 100 jobs per company.", "default": 0 }, "onlyNewSinceLastRun": { "title": "Only new jobs since the last run", "type": "boolean", "description": "For scheduled monitoring: return only jobs that were not on the board during the previous run (the first run returns the matching jobs, up to the max per company, and saves the whole board as the baseline). Jobs that disappeared are listed in the REMOVED_JOBS record and in each company's status. Seen jobs are remembered per job board in the named key-value store below.", "default": false }, "stateStoreName": { "title": "State store name", "pattern": "^[a-zA-Z0-9-]{1,63}$", "type": "string", "description": "Name of the key-value store that remembers seen jobs and detected job boards between runs. Use a different name per independent monitor (e.g. one per schedule). Letters, digits and hyphens only.", "default": "ats-jobs-feed-state" }, "scanCareersPage": { "title": "Scan the company website when needed", "type": "boolean", "description": "If a domain or careers-page URL cannot be matched by slug, fetch that page once (respecting robots.txt) and look for links to a supported ATS board.", "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 } } } } } } } } } }