{ "openapi": "3.0.1", "info": { "title": "Lead database", "description": "Describe who you want to reach in one sentence and export the matching people or companies. Searches 271M professional profiles and 47M companies, working out the filters from your brief and matching companies semantically, not by category label.", "version": "0.0", "x-build-id": "0vTDZEA2HZg0zRMmH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leadspicker~lead-database/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leadspicker-lead-database", "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/leadspicker~lead-database/runs": { "post": { "operationId": "runs-sync-leadspicker-lead-database", "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/leadspicker~lead-database/run-sync": { "post": { "operationId": "run-sync-leadspicker-lead-database", "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": { "searchType": { "title": "What to return", "enum": [ "people", "company" ], "type": "string", "description": "People returns individual professionals with their current role and company. Companies returns company records only.", "default": "people" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "How many records to deliver. You are charged per delivered record, so this is your main cost control. Start small — 25 records is enough to see whether the brief resolved the way you meant — then scale up.", "default": 4000 }, "hqCountryCodes": { "title": "Countries", "type": "array", "description": "Pick one or more countries. The database covers Czechia and Slovakia best; the rest are listed because briefs often name them. For a country not in the list, or a multi-country region like DACH or EMEA, use Raw filter overrides (`hq_country_codes` / `hq_sales_regions`). Overrides whatever region the brief implied.", "items": { "type": "string", "enum": [ "CZ", "SK", "AT", "DE", "PL", "HU", "CH", "NL", "BE", "FR", "GB", "IE", "IT", "ES", "PT", "SE", "NO", "DK", "FI", "IS", "EE", "LV", "LT", "SI", "HR", "RS", "BA", "ME", "MK", "AL", "BG", "RO", "GR", "CY", "MT", "LU", "UA", "MD", "BY", "TR", "US", "CA", "MX", "BR", "AR", "CL", "CO", "AU", "NZ", "JP", "KR", "CN", "IN", "SG", "HK", "TW", "ID", "MY", "TH", "VN", "PH", "AE", "SA", "IL", "ZA", "EG", "NG", "KE", "MA" ], "enumTitles": [ "Czechia (CZ)", "Slovakia (SK)", "Austria (AT)", "Germany (DE)", "Poland (PL)", "Hungary (HU)", "Switzerland (CH)", "Netherlands (NL)", "Belgium (BE)", "France (FR)", "United Kingdom (GB)", "Ireland (IE)", "Italy (IT)", "Spain (ES)", "Portugal (PT)", "Sweden (SE)", "Norway (NO)", "Denmark (DK)", "Finland (FI)", "Iceland (IS)", "Estonia (EE)", "Latvia (LV)", "Lithuania (LT)", "Slovenia (SI)", "Croatia (HR)", "Serbia (RS)", "Bosnia and Herzegovina (BA)", "Montenegro (ME)", "North Macedonia (MK)", "Albania (AL)", "Bulgaria (BG)", "Romania (RO)", "Greece (GR)", "Cyprus (CY)", "Malta (MT)", "Luxembourg (LU)", "Ukraine (UA)", "Moldova, Republic of (MD)", "Belarus (BY)", "Türkiye (TR)", "United States (US)", "Canada (CA)", "Mexico (MX)", "Brazil (BR)", "Argentina (AR)", "Chile (CL)", "Colombia (CO)", "Australia (AU)", "New Zealand (NZ)", "Japan (JP)", "Korea, Republic of (KR)", "China (CN)", "India (IN)", "Singapore (SG)", "Hong Kong (HK)", "Taiwan, Province of China (TW)", "Indonesia (ID)", "Malaysia (MY)", "Thailand (TH)", "Viet Nam (VN)", "Philippines (PH)", "United Arab Emirates (AE)", "Saudi Arabia (SA)", "Israel (IL)", "South Africa (ZA)", "Egypt (EG)", "Nigeria (NG)", "Kenya (KE)", "Morocco (MA)" ] }, "default": [] }, "employeeRanges": { "title": "Company size", "type": "array", "description": "Headcount bands. Overrides any size implied by the brief.", "items": { "type": "string", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1000", "1001-5000", "5001-10000", "10001+" ], "enumTitles": [ "1–10 employees", "11–50 employees", "51–200 employees", "201–500 employees", "501–1,000 employees", "1,001–5,000 employees", "5,001–10,000 employees", "10,001+ employees" ] }, "default": [] }, "seniority": { "title": "Seniority", "type": "array", "description": "People search only. Overrides any seniority implied by the brief.", "items": { "type": "string", "enum": [ "c-level", "vp", "director", "manager", "senior", "junior", "partner", "owner", "individual-contributor", "unknown" ], "enumTitles": [ "C-level", "VP", "Director", "Manager", "Senior", "Junior", "Partner", "Owner", "Individual contributor", "Unknown" ] }, "default": [] }, "titleIncludes": { "title": "Job title contains", "type": "array", "description": "People search only. Any one of these terms matching the current job title is enough, so \"Head of Product\" and \"VP Product\" together widen the search rather than narrow it. Leave empty to let the brief decide.", "default": [], "items": { "type": "string" } }, "referenceCompanyUrls": { "title": "Companies to look like", "type": "array", "description": "Paste LinkedIn company URLs or handles — \"productboard\" or \"https://linkedin.com/company/productboard\" both work. The search then looks for companies like those and the best-matching people inside them, which caps a run at roughly 20,000 people. The most reliable way to say \"more companies like these\".", "default": [], "items": { "type": "string" } }, "excludeCompanies": { "title": "Exclude companies", "type": "array", "description": "Companies to leave out of the results — existing customers, competitors, your own company. Give a company name (\"Heureka\", which also catches \"Heureka Group\"), a website domain (\"heureka.group\"), or a LinkedIn handle or URL (\"productboard\"). Names match as substrings so a group takes its subsidiaries with it; domains and handles match exactly. Excluded rows are never delivered and never charged for, but the match count reported before delivery is taken before exclusions.", "default": [], "items": { "type": "string" } }, "includeCompanyDetails": { "title": "Fetch company descriptions", "type": "boolean", "description": "People search only. Adds each person's company description to their row. A person record does not carry one, so the Actor looks it up per company — the lookup is free, but it is rate-limited to roughly 150 per minute, so a run touching many distinct companies takes noticeably longer. Capped at 1,000 companies per run; rows past that still deliver, without the column.", "default": false }, "query": { "title": "Who are you looking for?", "maxLength": 400, "type": "string", "description": "One or two sentences, in any language. Name the role, the kind of company, and the region — for example \"heads of product at B2B SaaS companies in Czechia\" or \"výrobní firmy dělající automatizaci pro automotive\". Be specific; a tight brief resolves into far better filters than a vague one." }, "leadspickerApiKey": { "title": "Your Leadspicker API key (optional)", "type": "string", "description": "Leave empty to use the built-in key and pay per result here. Supply your own key (Leadspicker → User → Integrations → API Keys) to run against your own Leadspicker subscription at a nominal per-result price. The nominal rate requires an active PAID Leadspicker plan — keys on a free trial still work, but are charged at the standard per-result rate." }, "advanced": { "title": "Raw filter overrides", "type": "object", "description": "Raw API fields merged over everything above, for filters not exposed here (revenue, founded year, industries, keywords, has_phone, similarity tuning). For a people search, nest under \"company\" and \"people\": {\"company\": {\"founded_year_min\": 2015}}. For a company search, put fields at the top level. Unknown keys are rejected rather than ignored.", "default": {} }, "tricorder": { "title": "Buying-signal filters", "type": "object", "description": "Company intelligence filters: technologies, funding, hiring signals, e-shop and public-supplier flags, CZ/SK register and financial facts, premises, website traffic. Needs the Tricorder feature on the Leadspicker account — the register, financial, premises and e-shop fields need two further flags on top, which the run checks before charging. Matches only companies where both sides know the website domain.", "default": {} } } }, "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 } } } } } } } } } }