{ "openapi": "3.0.1", "info": { "title": "Website Contact Extractor: Emails, Phones & Socials", "description": "Extract business emails, phone numbers, address and social media profiles (LinkedIn, Facebook, Instagram, X, YouTube, TikTok) from any list of company websites. Checks the home page plus contact, about and imprint pages. Works with Google Maps results.", "version": "0.1", "x-build-id": "LcZGRHOk5KEJVs68S" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/redfoxscout~website-contact-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-redfoxscout-website-contact-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/redfoxscout~website-contact-extractor/runs": { "post": { "operationId": "runs-sync-redfoxscout-website-contact-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/redfoxscout~website-contact-extractor/run-sync": { "post": { "operationId": "run-sync-redfoxscout-website-contact-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": { "urls": { "title": "Company websites", "type": "array", "description": "Company websites or domains, one per line. Or pick a dataset below (e.g. Google Maps results). Or use \"Websites from another Actor\" below.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (optional)", "type": "array", "description": "Same as the list above, in Apify's standard start-URL format (handy when another tool or Actor passes startUrls).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "datasetId": { "title": "Websites from another Actor (optional)", "type": "string", "description": "Check the websites in another Actor run's results, e.g. Google Maps Scraper or any lead list. Pick the dataset here, or in an Actor-to-Actor integration set it to {{resource.defaultDatasetId}}. Its websites are added to the list above." }, "datasetUrlField": { "title": "Field with the website", "type": "string", "description": "The dataset field that holds the website or URL, e.g. website (Google Maps Scraper), url or domain. Dot paths like contact.website work. If it is empty, website, url and domain are tried.", "default": "website" }, "maxDatasetItems": { "title": "Max dataset rows", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Read at most this many rows from that dataset.", "default": 10000 }, "monitorName": { "title": "Change alert name (optional)", "type": "string", "description": "Name this list (e.g. \"clients-weekly\") to compare each run with the previous run of the same name. Every row then gets changeStatus (new, changed or unchanged) and changedFields. Best on an Apify schedule." }, "onlyChanges": { "title": "Only new and changed sites in the results", "type": "boolean", "description": "Needs a change alert name. Unchanged sites are still checked and charged as usual, but left out of the results, so each run's dataset is your change report.", "default": false }, "maxPagesPerSite": { "title": "Contact pages per site", "minimum": 0, "maximum": 10, "type": "integer", "description": "Besides the home page, how many contact, about or imprint pages to check on each site.", "default": 4 }, "includePeople": { "title": "People on team pages", "type": "boolean", "description": "List the people the company shows on its own team, about, leadership and staff pages: name, title, and the email, phone or LinkedIn shown beside them. Team pages count toward Contact pages per site. Off: no team pages are read and people is null.", "default": true }, "maxPeople": { "title": "Max people per site", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Most people returned per website (default 50, up to 1,000). Large firms list hundreds; raise this together with Directory pages.", "default": 50 }, "maxTeamPages": { "title": "Directory pages per site", "minimum": 0, "maximum": 50, "type": "integer", "description": "People directories split over several pages (law firms, agencies) are followed page by page ('Next'), up to this many extra pages per site, until the people limit is reached. Same price per site.", "default": 5 }, "includeUrlPatterns": { "title": "Only check pages matching (optional)", "type": "array", "description": "Check only pages whose URL matches one of these, e.g. team, locations or */team*. A * matches any text; a word without * matches anywhere in the URL. Empty = the contact, about and imprint pages found through links or the sitemap.", "default": [], "items": { "type": "string" } }, "excludeUrlPatterns": { "title": "Skip pages matching (optional)", "type": "array", "description": "Never check pages whose URL matches one of these, e.g. blog or */news/*. Same matching as above.", "default": [], "items": { "type": "string" } }, "checkEmailDomains": { "title": "Check that email domains accept mail", "type": "boolean", "description": "Look up each email domain's mail servers (MX). Addresses on domains that cannot receive mail are left out of emails and primaryEmail but stay in emailsChecked with their status. Free: no mail is sent.", "default": true }, "maxConcurrency": { "title": "Sites in parallel", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many sites to check at once.", "default": 20 }, "requestTimeoutSecs": { "title": "Timeout per site (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Give up on a site after this long.", "default": 30 }, "proxyConfiguration": { "title": "Proxy (optional)", "type": "object", "description": "Off by default. Turn on if some sites block or rate-limit the checks.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }