{ "openapi": "3.0.1", "info": { "title": "Company Enrichment — Emails, Phones, Socials & Tech Stack", "description": "Turns a list of company websites into structured company profiles: contact emails, phone numbers, social profiles, address and the technologies each site runs on.", "version": "0.1", "x-build-id": "GihDtvEjjDRndcu4g" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maged120~company-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maged120-company-enrichment", "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/maged120~company-enrichment/runs": { "post": { "operationId": "runs-sync-maged120-company-enrichment", "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/maged120~company-enrichment/run-sync": { "post": { "operationId": "run-sync-maged120-company-enrichment", "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", "required": [ "domains" ], "properties": { "domains": { "title": "Company Websites", "type": "array", "description": "The companies to enrich. Paste a bare domain (acme.com), a full URL, or a www address — all are accepted. Duplicates are removed automatically.", "items": { "type": "string" } }, "maxPagesPerSite": { "title": "Pages to Crawl per Company", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages to read per company. Higher values find more contacts and take longer.", "default": 4 }, "excludeTypes": { "title": "Exclude Result Types", "type": "array", "description": "Result types to leave out of the output. Anything you exclude is not even looked for, so the run is faster and you are never billed for it. You cannot exclude everything — if you select them all, the company row is kept so the output is never empty.", "items": { "type": "string", "enum": [ "company", "description", "address", "logo", "email", "phone", "social", "technology" ], "enumTitles": [ "Company name", "Description", "Address", "Logo", "Emails", "Phones", "Social profiles", "Technologies" ] }, "default": [] }, "companyEmailsOnly": { "title": "Company-Domain Emails Only", "type": "boolean", "description": "On by default: return only email addresses on the company's own domain (e.g. name@thecompany.com). Turn this off to also collect other addresses found on the site — note this can include unrelated third-party or personal emails quoted in page content.", "default": true }, "allowBrowser": { "title": "Use a Browser When a Site Needs One", "type": "boolean", "description": "On by default. Automatically re-reads difficult sites (JavaScript-only or protected) for the best coverage, while keeping easy sites fast. Switch off only for the cheapest possible run.", "default": true }, "maxResultsPerType": { "title": "Max Results per Type, per Company", "minimum": 0, "type": "integer", "description": "Caps how many emails, phones, social profiles and technologies each company can return. Set to 0 for unlimited.", "default": 25 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy settings. Not required for most websites — enable it if some sites block the request or you process very large lists.", "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 } } }, "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 } } } } } } } } } }