{ "openapi": "3.0.1", "info": { "title": "ICP-Qualified Hiring Reqs", "description": "Get the hiring reqs that match your ICP definition — company market and size, seniority, skills, geography — from an already-normalized cross-source corpus, with agency and aggregator postings excluded.", "version": "0.1", "x-build-id": "9A1QJ1Qa4x995cpoL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reqbeat~icp-qualified-hiring-reqs/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reqbeat-icp-qualified-hiring-reqs", "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/reqbeat~icp-qualified-hiring-reqs/runs": { "post": { "operationId": "runs-sync-reqbeat-icp-qualified-hiring-reqs", "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/reqbeat~icp-qualified-hiring-reqs/run-sync": { "post": { "operationId": "run-sync-reqbeat-icp-qualified-hiring-reqs", "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": { "industry": { "title": "Industry (exact)", "type": "array", "description": "Match the company's industry label exactly. Supply several to match any of them.", "items": { "type": "string" } }, "industry_terms": { "title": "Industry contains", "type": "array", "description": "Match the company's industry label by substring, so \"internet\" reaches \"Technology, Information and Internet\". Use this when the exact label is longer than the market you mean.", "items": { "type": "string" } }, "company_kind": { "title": "Company kind", "type": "array", "description": "Restrict to companies of a given kind. Most buyers leave this empty and use \"Exclude agencies and aggregators\" below instead.", "items": { "type": "string" } }, "company_country": { "title": "Company country", "type": "array", "description": "The country the company itself is in, as distinct from where a given req is located.", "items": { "type": "string" } }, "headcount_band": { "title": "Company size", "type": "array", "description": "Pick one or more employee-count bands. Size is a band rather than a numeric range, so a company is in exactly one of these and \"50-100\" is not a size this corpus can be asked about.", "items": { "type": "string", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1000", "1001-5000", "5001+" ] } }, "seniority_level": { "title": "Seniority", "type": "array", "description": "The normalized seniority of the req, extracted from the posting rather than read off its title.", "items": { "type": "string" } }, "job_family": { "title": "Job family", "type": "array", "description": "The normalized job family of the req. This is the axis to use for broad functional targeting.", "items": { "type": "string" } }, "remote_type": { "title": "Remote type", "type": "array", "description": "The working arrangement the posting states.", "items": { "type": "string" } }, "skills": { "title": "Skills", "type": "array", "description": "Match a req carrying any of these extracted skills.", "items": { "type": "string" } }, "title_keywords": { "title": "Title keywords", "type": "array", "description": "Match whole words in the posting title, so \"go\" matches \"Go Engineer\" and never \"Django Developer\". Supply several to match any of them.", "items": { "type": "string" } }, "title_excludes": { "title": "Title must not contain", "type": "array", "description": "Veto a req whose title carries any of these whole words — \"sales\" and \"recruiter\" against a keyword of \"engineer\", for instance. A req whose title we do not hold is not vetoed: an unknown title cannot prove an exclusion.", "items": { "type": "string" } }, "location_keywords": { "title": "Location keywords", "type": "array", "description": "Match whole words in the req's stated location, so \"london\" reaches \"London Area\" and \"Greater London\" but never \"Londonderry\". This narrows within a country rather than replacing \"Req country\". A city spelled differently is a different word — supply \"munich\" and \"münchen\", or \"cologne\" and \"köln\", as separate keywords to match either.", "items": { "type": "string" } }, "board": { "title": "Source board", "type": "array", "description": "Restrict to reqs detected on a given board.", "items": { "type": "string" } }, "source_type": { "title": "Source type", "type": "array", "description": "Restrict to a class of source rather than a named one.", "items": { "type": "string" } }, "ats_vendor": { "title": "ATS vendor", "type": "array", "description": "Restrict to reqs whose source is a given applicant-tracking system.", "items": { "type": "string" } }, "country": { "title": "Req country", "type": "array", "description": "The country the req itself is located in.", "items": { "type": "string" } }, "company_ids": { "title": "Specific company ids", "type": "array", "description": "Restrict to named accounts by their Reqbeat company id.", "items": { "type": "string" } }, "exclude_agencies": { "title": "Exclude agencies and aggregators", "type": "boolean", "description": "Drop staffing-agency, aggregator and job-board postings, so a result names the employer rather than someone re-listing them. On by default.", "default": true }, "live_only": { "title": "Exclude expired and superseded reqs", "type": "boolean", "description": "Drop reqs whose recorded lifecycle status is no longer current. This reads the status the corpus holds; it is not a re-fetch of the posting at run time. On by default.", "default": true }, "salary_min_usd": { "title": "Pay band floor (yearly USD)", "type": "integer", "description": "Keep reqs at or above this yearly USD figure. The figure compared is the employer's declared salary where there is one and our inferred median otherwise, and the inferred one qualifies only above a sample floor. A req carrying no pay information at all matches no band." }, "salary_max_usd": { "title": "Pay band ceiling (yearly USD)", "type": "integer", "description": "Keep reqs at or below this yearly USD figure. Either bound alone is half-open; both together bracket one comparable figure per req." }, "since": { "title": "First seen since", "type": "string", "description": "An ISO-8601 timestamp. Only reqs first seen after it are returned." }, "since_last_run": { "title": "Only what is new since your last run", "type": "boolean", "description": "Resume from where your previous run of this actor finished, so a scheduled run returns only what has arrived since. Kept per account in this actor's own key-value store. On by default; turn it off to re-read the whole ICP from the start.", "default": true }, "max_reqs": { "title": "Stop after this many reqs", "minimum": 1, "type": "integer", "description": "A ceiling on what one run delivers. Leave empty to take everything matching your ICP. The first 10 qualified reqs each calendar month are free. Starting a run costs nothing and a run that matches nothing costs nothing — you are charged per qualified req, after it has been delivered." }, "page_size": { "title": "Reqs per request", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many reqs to ask for at a time, between 1 and 100. Affects pacing only, never the total.", "default": 25 } } }, "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 } } }, "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 } } } } } } } } } }