{ "openapi": "3.0.1", "info": { "title": "ATS Jobs API: Greenhouse, Lever, Ashby & Workable", "description": "Get every open job from company career sites on Greenhouse, Lever, Ashby, Workable, SmartRecruiters, Recruitee, Personio and BambooHR. Paste a careers URL, board slug, domain or company name; get clean, normalised job rows with salary, remote flag and apply URL.", "version": "1.0", "x-build-id": "Qy8MynJLcZilvIZt8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidewell~ats-jobs-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidewell-ats-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/tidewell~ats-jobs-api/runs": { "post": { "operationId": "runs-sync-tidewell-ats-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/tidewell~ats-jobs-api/run-sync": { "post": { "operationId": "run-sync-tidewell-ats-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", "type": "array", "description": "One per line. Any of: a careers or job-board URL (https://boards.greenhouse.io/airtable, https://jobs.lever.co/palantir, https://jobs.ashbyhq.com/1password, https://apply.workable.com/fe-fundinfo, https://careers.smartrecruiters.com/ServiceNow, https://bunq.recruitee.com, https://acme.jobs.personio.de, https://acme.bamboohr.com/careers); an explicit 'ats:slug' such as greenhouse:stripe; a company website such as notion.so (the actor finds the job board linked from the site); or a company name such as Monzo (the actor tries the likely board slug on every supported ATS).", "items": { "type": "string" } }, "defaultAts": { "title": "ATS for bare slugs and names", "enum": [ "auto", "greenhouse", "lever", "ashby", "workable", "smartrecruiters", "recruitee", "personio", "bamboohr" ], "type": "string", "description": "When an input line is a bare slug or company name, 'Auto' tries every supported ATS and keeps the board with the most open jobs. Pick one ATS to skip the guessing.", "default": "auto" }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep jobs whose title, department or team contains any of these words (whole-word, case-insensitive; use * as a wildcard), e.g. 'engineer', 'data', 'account executive', 'develop*'.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop jobs whose title contains any of these words (whole-word; * is a wildcard), e.g. 'intern*' (intern, internship), 'senior', 'manager'.", "items": { "type": "string" } }, "searchInDescription": { "title": "Match keywords in the job description too", "type": "boolean", "description": "Also match keywords against the full job description (for skills like 'Python' or 'Kubernetes'). For SmartRecruiters this needs one extra request per job, so it is slower.", "default": false }, "locations": { "title": "Locations", "type": "array", "description": "Keep jobs whose location text contains any of these (case-insensitive), e.g. 'London', 'United Kingdom', 'GB', 'Berlin', 'Remote'.", "items": { "type": "string" } }, "remoteOnly": { "title": "Remote jobs only", "type": "boolean", "description": "Keep only jobs the ATS marks as remote, or whose location says Remote / Anywhere / Work from home.", "default": false }, "departments": { "title": "Departments / teams", "type": "array", "description": "Keep jobs whose department or team contains any of these (case-insensitive), e.g. 'Engineering', 'Sales', 'Marketing'.", "items": { "type": "string" } }, "postedWithinDays": { "title": "Posted within (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Keep jobs first published in the last N days. Jobs with no published date are dropped when this is set." }, "includeDescription": { "title": "Include job description", "type": "boolean", "description": "Add description_html and description_text to each row. Off by default to keep rows small. Salary is still extracted from descriptions when it is not published as a structured field.", "default": false }, "maxJobsPerCompany": { "title": "Max jobs per company", "minimum": 1, "type": "integer", "description": "Stop after this many matching jobs from one board. Leave empty for no limit." }, "maxJobs": { "title": "Max jobs in total", "minimum": 1, "type": "integer", "description": "Stop the whole run after this many jobs. Leave empty for no limit. You can also cap spend with the run's maximum cost setting." }, "onlyNewJobs": { "title": "Only jobs not seen in earlier runs", "type": "boolean", "description": "Skip jobs this actor already returned in a previous run with the same state key. Job IDs are kept for 365 days in your named key-value store 'ats-jobs-state'.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Name for the seen-jobs memory, so separate feeds don't share it (e.g. 'uk-data-jobs'). Letters, digits and hyphens.", "default": "default" }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 32, "type": "integer", "description": "Total parallel HTTP requests. A per-host limit of 4 also applies, so ATS servers are never hammered.", "default": 8 } } }, "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 } } } } } } } } } }