{ "openapi": "3.0.1", "info": { "title": "Company Job Search API: Greenhouse, Lever, Ashby & more", "description": "Search open jobs posted directly on company career sites (Greenhouse, Lever, Ashby, Workable, SmartRecruiters, Recruitee, BambooHR, Workday). Keyword, country, remote, salary and seniority filters, clean salary fields, and only-new-jobs monitoring.", "version": "1.0", "x-build-id": "Fup1i5aLtPNjQT3og" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lucymade~ats-job-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lucymade-ats-job-search", "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/lucymade~ats-job-search/runs": { "post": { "operationId": "runs-sync-lucymade-ats-job-search", "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/lucymade~ats-job-search/run-sync": { "post": { "operationId": "run-sync-lucymade-ats-job-search", "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": { "keywords": { "title": "Job title keywords", "type": "array", "description": "Return jobs whose title contains any of these words or phrases, e.g. \"data engineer\", \"react\", \"product designer\". Leave empty to get all jobs.", "items": { "type": "string" } }, "keywordScope": { "title": "Match keywords in", "enum": [ "title", "title_description" ], "type": "string", "description": "Search only the job title (precise) or the title and the full description (broader).", "default": "title" }, "excludeKeywords": { "title": "Exclude titles containing", "type": "array", "description": "Drop jobs whose title contains any of these, e.g. \"intern\", \"senior\", \"sales\".", "items": { "type": "string" } }, "companies": { "title": "Only these companies (optional)", "type": "array", "description": "Company names, website domains or careers-page links, e.g. \"Stripe\", \"notion.so\", \"https://jobs.lever.co/spotify\". We find which job board each company uses. Companies we can't find are listed in the run's OUTPUT and never charged. Leave empty to search every company in the index.", "items": { "type": "string" } }, "countries": { "title": "Countries or regions", "type": "array", "description": "Two-letter country codes (US, GB, DE, CA, IN, ...) or regions: EU, EMEA, APAC, LATAM, NA, WORLD (\"anywhere\").", "items": { "type": "string" } }, "locations": { "title": "Location contains", "type": "array", "description": "Free-text match on the location, e.g. \"Berlin\", \"New York\", \"Remote\".", "items": { "type": "string" } }, "workplaceTypes": { "title": "Workplace", "type": "array", "description": "Remote, hybrid or on-site.", "items": { "type": "string", "enum": [ "remote", "hybrid", "onsite" ], "enumTitles": [ "Remote", "Hybrid", "On-site" ] } }, "employmentTypes": { "title": "Employment type", "type": "array", "description": "Full-time, part-time, contract, internship or temporary, as stated by the employer.", "items": { "type": "string", "enum": [ "full-time", "part-time", "contract", "internship", "temporary" ], "enumTitles": [ "Full-time", "Part-time", "Contract", "Internship", "Temporary" ] } }, "seniority": { "title": "Seniority (from the job title)", "type": "array", "description": "Worked out from the job title, e.g. Senior, Staff, Manager, Director.", "items": { "type": "string", "enum": [ "intern", "entry", "mid", "senior", "lead", "manager", "director", "executive" ], "enumTitles": [ "Intern", "Entry / junior", "Mid", "Senior", "Lead / staff / principal", "Manager", "Director / head of", "Executive / VP" ] } }, "departments": { "title": "Department or team contains", "type": "array", "description": "e.g. \"Engineering\", \"Marketing\".", "items": { "type": "string" } }, "postedWithinDays": { "title": "Posted within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only jobs posted in the last N days." }, "hasSalary": { "title": "Only jobs that show a salary", "type": "boolean", "description": "Skip jobs that don't publish a pay range.", "default": false }, "minAnnualSalary": { "title": "Minimum yearly salary", "minimum": 0, "type": "integer", "description": "Top of the posted range must be at least this much per year. Hourly and monthly pay is converted to yearly. Jobs without a salary are excluded when this is set." }, "salaryCurrency": { "title": "Salary currency", "type": "string", "description": "Use with minimum salary, e.g. USD, EUR, GBP, CAD." }, "visaSponsorship": { "title": "Only jobs that mention visa sponsorship", "type": "boolean", "description": "Keep only jobs whose description says visa sponsorship is available.", "default": false }, "onlyNewSinceLastRun": { "title": "Only new jobs since my last run", "type": "boolean", "description": "For scheduled runs: return only jobs that appeared after the previous run with the same memory name. You pay only for the new jobs.", "default": false }, "stateKey": { "title": "Memory name for \"only new\"", "type": "string", "description": "Use a different name for each saved search you schedule.", "default": "default" }, "status": { "title": "Job status", "enum": [ "open", "closed", "all" ], "type": "string", "description": "Open jobs (default), or jobs the company recently took down (useful for hiring-signal research).", "default": "open" }, "closedWithinDays": { "title": "Closed within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "With \"Recently closed\": only jobs taken down in the last N days." }, "ats": { "title": "Job board platforms", "type": "array", "description": "Limit to some platforms. Leave empty for all.", "items": { "type": "string", "enum": [ "greenhouse", "lever", "ashby", "workable", "smartrecruiters", "recruitee", "bamboohr", "workday" ], "enumTitles": [ "Greenhouse", "Lever", "Ashby", "Workable", "SmartRecruiters", "Recruitee", "BambooHR", "Workday" ] } }, "includeDescription": { "title": "Include full job description", "type": "boolean", "description": "Adds the description as plain text (and HTML for live-fetched companies).", "default": false }, "maxItems": { "title": "Max jobs", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many jobs.", "default": 100 } } }, "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 } } } } } } } } } }