{ "openapi": "3.0.1", "info": { "title": "Jobs Search API – Search Career Sites by Job Title & Country", "description": "Search jobs by title, country, and keyword across the career sites of hundreds of companies on Workday, Greenhouse, Lever, Ashby, and Workable. Live data straight from each employer's board, with new and closed job alerts.", "version": "0.1", "x-build-id": "IRKk6vPFGkAxNHolT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pharaoh_data~jobs-search-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pharaoh_data-jobs-search-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/pharaoh_data~jobs-search-api/runs": { "post": { "operationId": "runs-sync-pharaoh_data-jobs-search-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/pharaoh_data~jobs-search-api/run-sync": { "post": { "operationId": "run-sync-pharaoh_data-jobs-search-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", "properties": { "jobTitles": { "title": "Job titles", "type": "array", "description": "Phrases to find in job titles, such as \"data engineer\" or \"account executive\". A job matches if its title contains any of them.", "items": { "type": "string" }, "default": [] }, "countries": { "title": "Countries", "type": "array", "description": "Keep jobs in these countries (names or ISO codes, such as US, Germany, \"United Arab Emirates\"). Leave empty for all.", "items": { "type": "string" }, "default": [] }, "locations": { "title": "Locations", "type": "array", "description": "Optional city or region terms, such as London, Remote, or Dubai.", "items": { "type": "string" }, "default": [] }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional terms to find in the title, description, department, or location, such as Python or fintech.", "items": { "type": "string" }, "default": [] }, "postedWithinDays": { "title": "Posted within days", "minimum": 0, "maximum": 365, "type": "integer", "description": "Keep jobs posted within this many days. 0 disables the filter.", "default": 0 }, "providers": { "title": "Job board systems", "type": "array", "description": "Search only boards on these systems. Leave empty for all five.", "items": { "type": "string", "enum": [ "greenhouse", "lever", "ashby", "workable", "workday" ], "enumTitles": [ "Greenhouse", "Lever", "Ashby", "Workable", "Workday" ] }, "default": [] }, "companies": { "title": "Only these companies", "type": "array", "description": "Optional: search only these companies from the index, such as Stripe or Careem. To search a company that isn't in the index, add its board URL below.", "items": { "type": "string" }, "default": [] }, "excludeCompanies": { "title": "Exclude companies", "type": "array", "description": "Optional: companies to leave out, such as your own employer or current clients.", "items": { "type": "string" }, "default": [] }, "additionalBoardUrls": { "title": "Extra job board URLs", "type": "array", "description": "Optional Greenhouse, Lever, Ashby, Workable, or Workday board URLs to search as well, such as https://jobs.lever.co/palantir.", "items": { "type": "string" }, "default": [] }, "maxBoards": { "title": "Maximum boards to search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Boards that can match are searched in order of how many jobs they have in your countries (or overall). More boards find more jobs and take longer.", "default": 100 }, "maxJobsPerCompany": { "title": "Maximum jobs per board", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum matching jobs saved from each board.", "default": 200 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum job records saved per run, including closed-job records. Each record is one billable result.", "default": 1000 }, "includeDescriptions": { "title": "Include job descriptions", "type": "boolean", "description": "Include plain-text descriptions. Workday descriptions need one extra request per job.", "default": true }, "trackChanges": { "title": "Track changes between runs", "type": "boolean", "description": "Label jobs new, updated, or unchanged compared with the previous run of the same search, and report jobs that disappeared as closed. History is kept in your account's named key-value store jobs-search-api-state.", "default": true }, "outputMode": { "title": "Output", "enum": [ "all", "changes" ], "type": "string", "description": "\"All matching jobs\" saves every match. \"Changes only\" saves new, updated, and closed jobs, for alerts.", "default": "all" }, "includeClosed": { "title": "Report closed jobs", "type": "boolean", "description": "Save a record with changeType \"closed\" when a previously saved job is no longer listed on a fully read board.", "default": true }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Optional name for this search's history. When empty, it is derived from the search settings.", "default": "" }, "redactContactDetails": { "title": "Redact contact details in descriptions", "type": "boolean", "description": "Remove email addresses, phone numbers, and personal LinkedIn links from descriptions.", "default": true }, "maxConcurrency": { "title": "Boards in parallel", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many boards to read at once (1–8). Requests to each host stay rate-limited.", "default": 4 } } }, "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 } } } } } } } } } }