{
"openapi": "3.0.1",
"info": {
"title": "Email Finder API",
"description": "Find work e-mail addresses from a person's name and their company or domain: the address, its layout, a confidence level, the evidence behind it and the mail provider. Export scraped data, run the scraper via API, schedule and monitor runs, or integrate with other tools or AI workflows.",
"version": "0.1",
"x-build-id": "Fd7QHLVXZZmDAs1J8"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/lergassy~email-finder-api/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-lergassy-email-finder-api",
"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/lergassy~email-finder-api/runs": {
"post": {
"operationId": "runs-sync-lergassy-email-finder-api",
"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/lergassy~email-finder-api/run-sync": {
"post": {
"operationId": "run-sync-lergassy-email-finder-api",
"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": {
"people": {
"title": "๐ค People to find",
"type": "array",
"description": "One person per line, written as Full Name, company. The company can be a domain (stripe.com), a website (https://stripe.com/about) or just the company's name (Clifford Chance) โ the Actor works out the domain either way. Jane Doe @ acme.com works too.",
"items": {
"type": "string"
}
},
"candidatesPerPerson": {
"title": "๐ฏ Addresses per person",
"minimum": 1,
"maximum": 8,
"type": "integer",
"description": "How many address candidates to return. The first is the answer; the rest are the next most likely layouts, listed in alternatives for when the first one bounces.",
"default": 3
},
"checkMx": {
"title": "Check the mail domain",
"type": "boolean",
"description": "Look up the company's mail servers, so you know whether the domain accepts mail at all and who runs it (Google Workspace, Microsoft 365, and so on). Free and fast โ leave it on.",
"default": true
},
"includeCompanyRows": {
"title": "Add one row per company",
"type": "boolean",
"description": "Write an extra row for each company with the address layout found, the addresses it was read from, and every public address on the site. These rows have different columns from the people rows, so the table shows blanks where a column does not apply โ leave it off unless you want that company sheet.",
"default": false
},
"maxPagesPerCompany": {
"title": "Pages to read per company",
"minimum": 1,
"maximum": 12,
"type": "integer",
"description": "How deep to read each company's website looking for published addresses. Contact, about, team and legal pages are read first, so more than six rarely finds anything new.",
"default": 4
},
"maxPeople": {
"title": "๐งพ Max people per run",
"minimum": 1,
"type": "integer",
"description": "A ceiling on how many people this run may look up, whatever the input contains. Leave the default unless you are running a big list on purpose.",
"default": 1000
},
"peopleList": {
"title": "People as records",
"type": "array",
"description": "An array of objects: {\"firstName\": \"Jane\", \"lastName\": \"Doe\", \"company\": \"acme.com\"}. fullName works in place of the two name fields, and domain, website or url in place of company."
},
"inputDatasetId": {
"title": "Dataset with people",
"type": "string",
"description": "ID of an Apify dataset to read the people from โ for example the output of US Business Leads or any lead list you already have on the platform."
},
"nameField": {
"title": "Full-name column",
"type": "string",
"description": "Which column of that dataset holds the person's full name.",
"default": "fullName"
},
"firstNameField": {
"title": "First-name column",
"type": "string",
"description": "Which column holds the first name, when the name is split into two.",
"default": "firstName"
},
"lastNameField": {
"title": "Last-name column",
"type": "string",
"description": "Which column holds the last name.",
"default": "lastName"
},
"companyField": {
"title": "Company column",
"type": "string",
"description": "Which column holds the company name, domain or website.",
"default": "company"
},
"concurrency": {
"title": "Parallel look-ups",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many companies to read at once. Lower it if a target website starts refusing requests.",
"default": 5
},
"pageTimeoutSecs": {
"title": "Page timeout (seconds)",
"minimum": 3,
"maximum": 60,
"type": "integer",
"description": "How long to wait for one page of a company website.",
"default": 15
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Not needed for ordinary business websites โ this Actor sends plain HTTP requests and no browser. Turn a proxy on only if you are reading thousands of sites and some start refusing.",
"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
}
}
}
}
}
}
}
}
}
}