{
  "openapi": "3.0.1",
  "info": {
    "title": "Company Contact Details & Website Email Finder",
    "description": "Contact information scraper and email extractor for B2B lead generation: emails, phone numbers, WhatsApp numbers, contact forms and social media links (LinkedIn URLs, Facebook, Instagram) from company websites, domains or Google Maps. B2B leads and contact enrichment; pay per site with an email.",
    "version": "0.7",
    "x-build-id": "YqvS34t9fQMdmgDKp"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/datagleaner~website-contact-details-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-datagleaner-website-contact-details-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/datagleaner~website-contact-details-scraper/runs": {
      "post": {
        "operationId": "runs-sync-datagleaner-website-contact-details-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/datagleaner~website-contact-details-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-datagleaner-website-contact-details-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",
        "properties": {
          "searchQueries": {
            "title": "Lead lists: industry and city (Google Maps searches)",
            "type": "array",
            "description": "Find leads by industry and city: one search per line, such as `dentists in Austin, TX` or `plumbers in Denver, CO`. Each search returns local businesses with their emails, phones and social profiles, one row per business. The run first finds the businesses with our Google Maps Leads Actor as a sub-run on your account, then scans each business's website. Cost of this mode: Google Maps Leads bills its own per-place price for each business found (US$0.0015 today), and this Actor bills US$0.002 per business whose website has an email; about US$0.27 for 100 businesses if 60 have an email. A business with no website gets one free row with `failureReason: no_website_on_maps`. Leave empty to scan your own list of websites instead.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxPlacesPerQuery": {
            "title": "Businesses per search",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Only used with lead lists. How many businesses to take from each search (default 20, up to 200). Each business found is billed by Google Maps Leads at its own per-place price.",
            "default": 20
          },
          "osmQueries": {
            "title": "Lead lists from OpenStreetMap (worldwide)",
            "type": "array",
            "description": "Optional lead source for any country: one search per line, a business type and a place, such as `dentists in Leeds, UK`, `plumbers in Brisbane, Australia` or `Zahnarzt in München` (common business types work in English, German, French, Spanish, Italian, Dutch and Portuguese). An OpenStreetMap tag works too: `shop=bakery in Lyon` or `craft=roofer,craft=carpenter | Auckland`. The Actor reads the businesses OpenStreetMap has for that type inside the place's boundary (businesses with a website first), then scans each business's own website for contacts. Cost of this mode: no charge for the OpenStreetMap listings; US$0.002 per business whose website has an email, like any other site. A business with no website gets one free row with `failureReason: no_website_on_openstreetmap`. OpenStreetMap is mapped by volunteers, so coverage varies by city. Can be combined with the other lead lists; a website found twice is scanned once.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxOsmResults": {
            "title": "Businesses per OpenStreetMap search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Only used with OpenStreetMap lead lists. How many businesses to take from each search (up to 1,000), businesses with a website first.",
            "default": 100
          },
          "overpassUrl": {
            "title": "Your own Overpass API endpoint (optional)",
            "type": "string",
            "description": "Only used with OpenStreetMap lead lists. The full interpreter URL of your own or a paid Overpass API server, such as `https://overpass.example.com/api/interpreter`; it is tried before the public servers, and it is stored encrypted because a paid endpoint's URL can hold its key. Leave empty to use the public servers that allow commercial use. overpass-api.de is not accepted: its terms do not allow commercial use."
          },
          "websites": {
            "title": "Websites (if you already have a list)",
            "type": "array",
            "description": "Company websites to scan, one per line. `example.com` and `https://www.example.com/` both work. Only the same domain is crawled. Example: `[\"acme.com\", \"https://www.example.org\"]`. Cost of this mode: US$0.002 per site where an email is found; sites with no email are free. Give at least one of the lead lists, Websites, Company names, Start URLs or a Dataset ID; with none, a small built-in 1-site example runs.",
            "items": {
              "type": "string"
            }
          },
          "companyNames": {
            "title": "Company names (instead of websites)",
            "type": "array",
            "description": "Optional. Company names, one per line, when you do not have their websites. Runs Company Domain Finder on your account to find each company's website first; it bills its own $0.0008 per website found (no charge when none is found), then this Actor bills as usual. A name with no website found gets one free row with `failureReason`. Add a location after a comma to tell same-named companies apart (`Bosch, Germany`). Example: `[\"Stripe\", \"Bosch, Germany\"]`.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "companyCountry": {
            "title": "Country for the company names",
            "type": "string",
            "description": "Optional. A country name or ISO code (`DE`, `Japan`) passed to Company Domain Finder for every name that has none of its own. Only used with Company names. Example: `DE`."
          },
          "startUrls": {
            "title": "Start URLs (same format as other contact scrapers)",
            "type": "array",
            "description": "Optional alias of Websites, in the format other contact scrapers use: a list of `{\"url\": \"https://example.com\"}` objects. Merged with Websites and the dataset, duplicates removed. Example: `[{\"url\": \"https://example.com\"}]`.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "outputFormat": {
            "title": "Output format",
            "enum": [
              "default",
              "compatible"
            ],
            "type": "string",
            "description": "`compatible` also adds the field names other contact scrapers use (`url`, `originalStartUrl`, `domain`, `depth`, `referrerUrl`, `scrapedUrls`, `emails` and `phones` as plain string lists, `phonesUncertain`, `linkedIns`, `twitters`, `instagrams`, `facebooks`, `youtubes`, `tiktoks`, `pinterests`, `discords`, `snapchats`, `threads`, `telegrams`, `reddits`, `whatsapps`). Then `emails` and `phones` are plain strings and our detailed objects move to `emailDetails` and `phoneDetails`. Billing is unchanged.",
            "default": "default"
          },
          "datasetId": {
            "title": "Dataset ID from another run",
            "type": "string",
            "description": "Optional. Dataset ID of another run. Websites are read from the first present field of `website`, `url`, `domain`, `site`, `homepage`, `link`, `companyWebsite`, `web`. Items without a website are skipped, and each row carries the item's `title` or `name` as `sourceTitle`. Example: `Zk5f8GhJq2xYabcDe` (the run's `defaultDatasetId`)."
          },
          "datasetUrlField": {
            "title": "Website field in the dataset",
            "type": "string",
            "description": "Optional. Name of the dataset field that holds the website, tried before the default field names. Example: `companyWebsite`."
          },
          "maxDatasetItems": {
            "title": "Max dataset items to read",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Upper bound on how many items are read from the dataset.",
            "default": 1000
          },
          "csvUrl": {
            "title": "Google Sheet or CSV URL",
            "type": "string",
            "description": "Optional. A Google Sheets link (the normal /edit link works; the tab in `gid=` is read) or any public CSV / TSV / text file URL. Several URLs can be given separated by spaces. Example: `https://docs.google.com/spreadsheets/d/1AbC.../edit#gid=0`. Up to 200,000 rows per file."
          },
          "csvColumn": {
            "title": "Website column in the sheet / CSV",
            "type": "string",
            "description": "Optional. The column that holds the website: its header (`Website`), its letter (`C`) or its number (`3`). Left empty, the first column named website, url, domain, site, homepage or similar is used, else the column whose cells look most like websites. A `name`, `title` or `company` column is copied to each row as `sourceTitle`."
          },
          "skipSeenDomains": {
            "title": "Skip domains already delivered by earlier runs",
            "type": "boolean",
            "description": "Optional. When on, every domain this Actor delivered with an email (a billed row) is remembered in a key-value store on your own Apify account, and later runs with this option on skip those domains: no row, no charge. Sites that had no email are not remembered, so they are tried again. The skipped websites are listed in the run's key-value store under `SKIPPED_SEEN_DOMAINS`.",
            "default": false
          },
          "seenDomainsStoreName": {
            "title": "Seen-domains store name",
            "type": "string",
            "description": "Optional. Name of the key-value store on your account that remembers delivered domains. Use one name per campaign or client to keep their lists apart (lowercase letters, digits and dashes). Delete the store in Storage to start over.",
            "default": "contact-details-seen-domains"
          },
          "maxPagesPerSite": {
            "title": "Max pages per site",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Pages read per site: the home page plus the most promising contact, about, legal/impressum and team pages, up to this many. Also accepted under the name `maxRequestsPerStartUrl`.",
            "default": 8
          },
          "maxDepth": {
            "title": "Max link depth",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "How many links away from the start URL the crawl may go. `0` reads the start page only (no links, no sitemap). `1` (default) reads the start page and the pages it links to. `2` and more also follow contact-like links found on those pages, still within Max pages per site.",
            "default": 1
          },
          "includeUrlPatterns": {
            "title": "Only follow URLs matching",
            "type": "array",
            "description": "Optional. Follow only pages whose URL matches at least one pattern; the start URL is always read. A pattern is matched against the full URL, ignoring case. `*` matches any characters and `?` one character. A pattern without `*` or `?` matches when the URL contains it (`/about/`). A pattern with them must match the whole URL, so start it with `*` to match anywhere (`*/team/*`), or with `/` to match the path (`/en/*`). Start with `re:` for a regular expression (`re:/(contact|about)`). Objects `{\"glob\": \"...\"}` and `{\"regexp\": \"...\"}` also work. Leave empty to follow any page. Example: `[\"/contact\", \"*/team/*\"]`.",
            "items": {
              "type": "string"
            }
          },
          "excludeUrlPatterns": {
            "title": "Never follow URLs matching",
            "type": "array",
            "description": "Optional. Skip pages whose URL matches any pattern, same syntax as Only follow URLs matching (for example `/blog/`, `*/careers/*`, `re:\\.html$`). Exclude wins over include. The start URL is always read. Example: `[\"/blog/\"]`.",
            "items": {
              "type": "string"
            }
          },
          "extractPeople": {
            "title": "Extract people from team pages",
            "type": "boolean",
            "description": "Adds a `people` list to each site row: name, job title, seniority, department and, when the site prints one next to the person, an email. Read from the company's own team, about and leadership pages only (up to 25 people per site, up to 12 extra pages). Free for now: no extra charge.",
            "default": false
          },
          "website": {
            "title": "Website (one site, bare domain works)",
            "type": "string",
            "description": "One company website for a table or workflow that calls the Actor once per row, such as `example.com` or `https://example.com`. A bare domain gets `https://` added. If you also give Start URLs, this field wins and Start URLs is ignored. Works with or without `perRow`; all checks and billing are the same as for any other website."
          },
          "perRow": {
            "title": "One website per call (fast path for tables)",
            "type": "boolean",
            "description": "For a table or workflow that calls the Actor once per row with exactly one website. Reads the home page and the contact page only, on a shorter time limit per site (25 seconds), and returns one flat row: `bestEmail`, `emails`, `phones`, `contactPageUrl`, `status`, `failureReason`. All the same checks apply (robots.txt, bot challenges, site terms, EU/UK role-only addresses) and billing is unchanged: the per-email event is charged only for a row with a `bestEmail`. Pair it with `website` (a bare domain works). Ignored (normal crawl) when the run has more than one website.",
            "default": false
          },
          "fullCrawlFallback": {
            "title": "Full crawl when the fast path finds nothing",
            "type": "boolean",
            "description": "Only with `perRow`. For tools that cannot branch on a column (n8n, Zapier): when the fast path ends with no email or no contact page, the Actor runs the normal full crawl on that same site in the same run and still returns one row. Trade-off: more emails found, but those rows are slower (the full crawl can take up to a minute or more instead of a few seconds). Same checks (robots.txt, bot challenges, site terms) and the same billing: the per-email event is charged only for a row with a `bestEmail`, and a row that finds nothing is free. Off by default.",
            "default": false
          },
          "defaultCountry": {
            "title": "Default phone country",
            "type": "string",
            "description": "Optional ISO country code (e.g. `US`, `TW`, `JP`) used to read local phone numbers when the site's own country cannot be inferred. Leave empty to infer from the domain, page language and structured data."
          },
          "euRoleOnly": {
            "title": "EU/UK role mailboxes only",
            "type": "boolean",
            "description": "When on, sites in EU, EEA, UK and Swiss country domains return only generic company mailboxes such as info@ or post@; first-name work addresses are left out of those rows. Sites elsewhere are unchanged. Danish (.dk) sites, and rows with a .dk address or a +45 phone, never return emails in either setting.",
            "default": false
          },
          "respectRobotsTxt": {
            "title": "Respect robots.txt",
            "type": "boolean",
            "description": "Always on: robots.txt is binding, so pages a site's robots.txt disallows are never fetched. The setting is kept for compatibility and turning it off has no effect. Rows show how many pages were skipped in robotsBlocked.",
            "default": true
          },
          "maxConcurrency": {
            "title": "Sites in parallel",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many websites are crawled at the same time. Empty means 30 when the run has 2 GB of memory or more (the Actor picks 2 GB from 300 sites) and 10 below that."
          },
          "stopAt": {
            "title": "Stop at (for callers)",
            "type": "string",
            "description": "For callers: an ISO-8601 UTC timestamp (for example 2026-11-04T10:15:00Z). The run saves what it has, sets its status message and ends as succeeded shortly before this moment. Parent Actors set it so a queued sub-run does not outlive their wait. Empty or unreadable values are ignored; a past value ends the run at once."
          },
          "maxConcurrencyPerDomain": {
            "title": "Requests in parallel per domain",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Polite limit on simultaneous requests to a single website.",
            "default": 2
          },
          "requestTimeoutSecs": {
            "title": "Request timeout (seconds)",
            "minimum": 3,
            "maximum": 120,
            "type": "integer",
            "description": "How long to wait for each page before retrying.",
            "default": 20
          },
          "retryBlockedWithProxy": {
            "title": "Retry blocked sites through Apify Proxy",
            "type": "boolean",
            "description": "Ignored since 2026-11-01 (accepted so old inputs still run). A site that answers HTTP 403, 429 or 503, or a bot-check page, is no longer retried through another proxy: it is reported as blocked.",
            "default": true
          },
          "residentialRetry": {
            "title": "Use residential proxy for blocked sites",
            "type": "boolean",
            "description": "Ignored since 2026-11-01 (accepted so old inputs still run). Blocked sites are no longer retried through a residential proxy.",
            "default": false
          },
          "renderFallback": {
            "title": "Read pages in a browser when no email is found",
            "type": "boolean",
            "description": "Off by default. For a site that still has no email after the full plain crawl, opens its home page and its best contact page (2 pages at most) in a headless browser and reads the final page plus the data the page loaded. Slower (about 10 to 25 seconds per rendered site) and uses more memory: a run with this on starts with 2048 MB by default (1024 MB otherwise); if you set the memory yourself, give it 2048 MB or more. Only sites with no email are rendered; the Actor's price is unchanged.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. Defaults to no proxy. Format: `{\"useApifyProxy\": true}`. Leave empty to run without a proxy."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}