{ "openapi": "3.0.1", "info": { "title": "ZipRecruiter Jobs with Full Description Extractor", "description": "Search ZipRecruiter by keyword and location, or a direct search URL, and get each job's full description text alongside company, location, salary, and remote/hybrid details.", "version": "1.0", "x-build-id": "8VGgLzspVLnGioOxo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~ziprecruiter-jobs-with-full-description-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-ziprecruiter-jobs-with-full-description-extractor", "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/dataspryva~ziprecruiter-jobs-with-full-description-extractor/runs": { "post": { "operationId": "runs-sync-dataspryva-ziprecruiter-jobs-with-full-description-extractor", "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/dataspryva~ziprecruiter-jobs-with-full-description-extractor/run-sync": { "post": { "operationId": "run-sync-dataspryva-ziprecruiter-jobs-with-full-description-extractor", "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": { "startUrls": { "title": "ZipRecruiter URLs", "type": "array", "description": "ZipRecruiter search URLs (filters in the URL are honored, e.g. `https://www.ziprecruiter.com/jobs-search?search=software+engineer&location=New+York%2C+NY`) or individual job links like `https://www.ziprecruiter.com/c/Company/Job/Title/-in-City,ST?jid=...`.", "items": { "type": "string" }, "default": [] }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Job keywords to search, e.g. `registered nurse`, `software engineer`. Every query is searched in every location below.", "items": { "type": "string" }, "default": [] }, "locations": { "title": "Locations", "type": "array", "description": "Cities, states or `United States` for a national search. Leave empty to search the whole United States. Every query is searched in every location.", "items": { "type": "string" }, "default": [] }, "companyName": { "title": "Company name", "type": "string", "description": "Only jobs from one company, e.g. `Visa`. The name is resolved on ZipRecruiter. Leave Search queries empty to browse all of the company's jobs." }, "jobType": { "title": "Job type", "enum": [ "any", "full_time", "part_time", "contract", "contract_to_hire", "temporary", "as_needed", "other", "internship" ], "type": "string", "description": "Employment-type filter, applied to keyword searches.", "default": "any" }, "workplace": { "title": "Workplace type", "enum": [ "any", "remote", "hybrid", "onsite" ], "type": "string", "description": "Work-arrangement filter (remote includes jobs that offer a remote option).", "default": "any" }, "remoteOnly": { "title": "Remote only (legacy)", "type": "boolean", "description": "Kept for older tasks: same as setting Workplace type to `Remote`.", "default": false }, "experienceLevels": { "title": "Experience levels", "type": "array", "description": "Restrict to one or more seniority levels. Empty = no filter.", "items": { "type": "string", "enum": [ "no_experience", "junior", "mid", "senior" ], "enumTitles": [ "No experience", "Junior", "Mid", "Senior" ] }, "default": [] }, "daysPosted": { "title": "Posted within (days)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Only jobs posted within the last N days. 0 = any time.", "default": 0 }, "radiusMiles": { "title": "Search radius (miles)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Distance around the location. 0 = ZipRecruiter's default.", "default": 0 }, "salaryMin": { "title": "Minimum salary (annual USD)", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Lower bound of the pay range: only jobs whose advertised annual pay reaches at least this amount. 0 = no lower bound.", "default": 0 }, "salaryMax": { "title": "Maximum salary (annual USD)", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Upper bound of the pay range: only jobs whose advertised annual pay stays at or below this amount. 0 = no upper bound.", "default": 0 }, "quickApplyOnly": { "title": "1-Click Apply only", "type": "boolean", "description": "Only jobs that can be applied to on ZipRecruiter with 1-Click Apply.", "default": false }, "fetchDescriptions": { "title": "Fetch full descriptions", "type": "boolean", "description": "When on (recommended), each job's detail data and full description are fetched — the actor's core feature. Turn off for faster, cheaper runs with search-card fields only.", "default": true }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of job postings to return across all searches.", "default": 50 }, "maxSearches": { "title": "Max searches", "minimum": 1, "maximum": 100, "type": "integer", "description": "Cap on the number of query × location combinations when using Search queries (each combination is one search).", "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 } } } } } } } } } }