{ "openapi": "3.0.1", "info": { "title": "Workable Jobs Scraper — Company Job Boards", "description": "Every open role on any company's Workable careers page as structured data: title, department, places with country, employment type, remote flag, published date, pay range where the text states one, text on request. One request per board. Incremental mode charges only for changes. No personal data.", "version": "0.1", "x-build-id": "iR3KcXC5TJqilPXKv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/adderleydata~workable-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-adderleydata-workable-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/adderleydata~workable-jobs-scraper/runs": { "post": { "operationId": "runs-sync-adderleydata-workable-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/adderleydata~workable-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-adderleydata-workable-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": [ "boards" ], "properties": { "boards": { "title": "Job boards", "type": "array", "description": "One entry per company: its Workable account name (in https://apply.workable.com/acme/ it is \"acme\"), or any link that names it — the careers page, one of its jobs, its application page, or the legacy acme.workable.com address. A short job link (apply.workable.com/j/…) does not name the account, so give the careers page link instead. A company that shows its Workable jobs on its own domain still has an apply.workable.com page, and that name is needed. Up to 500 boards per run; each is one request.", "items": { "type": "string" } }, "keywords": { "title": "Title keywords", "type": "array", "description": "Keep jobs whose title contains every word of any keyword, in any order — \"engineer data\" matches \"Senior Data Engineer\". Leave empty for all titles.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Keep jobs with a place on the careers page containing this text (\"Athens\", \"Berlin\"), open in this country (\"Germany\", \"Australia\"), or marked remote by the company (\"Remote\"). Every place a job's careers page shows counts; places the company hides are never matched. Leave empty for all locations.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Keep jobs whose department contains this text, e.g. \"Engineering\". Leave empty for all departments.", "items": { "type": "string" } }, "postedWithinDays": { "title": "Published within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Keep jobs published on Workable in the last N days. Workable dates each job by the day, so a job published on the day N days ago counts. Leave empty for any time." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "The run stops once this many jobs are saved. You are charged per job saved, so this is also your cost cap.", "default": 100 }, "includeDescription": { "title": "Include full descriptions", "type": "boolean", "description": "On: the full job text — description, requirements and benefits, as Workable publishes them — comes back with each row, read from the same request as the listing, so it costs no extra requests. Off: listing fields only.", "default": false }, "descriptionFormat": { "title": "Description format", "enum": [ "text", "text_and_html" ], "type": "string", "description": "Plain text, or plain text plus sanitised HTML.", "default": "text" }, "redactContacts": { "title": "Redact contact details in descriptions", "type": "boolean", "description": "On by default: email addresses and phone numbers inside description text are replaced with [redacted]. This Actor never outputs recruiter names or contact fields.", "default": true }, "incremental": { "title": "Incremental mode", "type": "boolean", "description": "Remember what earlier runs saw and save only jobs that are new, changed or gone. Unchanged jobs are skipped and not charged. Put the Actor on a schedule with this on.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Optional name for this monitor, e.g. \"competitor-engineering\". Runs with the same key share memory. Left empty, a key is derived from the boards and filters themselves." }, "emitExpired": { "title": "Report expired jobs", "type": "boolean", "description": "Incremental mode only. When a complete run no longer finds a job it saw before, save one row with changeType EXPIRED.", "default": true }, "emitUnchanged": { "title": "Also save unchanged jobs", "type": "boolean", "description": "Incremental mode only. Saves (and charges for) every job, labelled UNCHANGED where nothing moved.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy, automatic group, is the default and is what this Actor is tested with.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests. One by default: Workable limits how often one address may ask, and one board at a time stays under that limit.", "default": 1 }, "maxRequestsPerMinute": { "title": "Maximum requests per minute", "minimum": 6, "maximum": 240, "type": "integer", "description": "An upper bound on request rate across the whole run. Ten by default, under the limit Workable applies to one address. If Workable still answers 429 (too many requests), the Actor waits as long as Workable asks, or 30 seconds, and asks again from the same address, at most twice.", "default": 10 } } }, "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 } } } } } } } } } }