Deeplead MCP
An official MCP server provided by Deeplead that enables AI agents to perform B2B lead generation and cold email outreach. It allows searching for local businesses and organizations, enriching company data, finding decision-makers with verified emails and phone numbers, managing contacts, creating and monitoring email campaigns, and checking deliverability.
Endpoint and access
No sign-in to connect and list tools. Individual tools may still need a vendor account, credentials, or permissions; check the documented prerequisites.
OAuth or API key
MCP endpoint (Streamable HTTP)
https://www.deeplead.io/api/mcpWhat its tools do
28 tools, grouped by the hints the server advertises. Hints are self-declared, not verified behavior.
Read-only (7)
Can change data (21)
businesses_searchorganizations_searchorganizations_enrichorganizations_find_decision_makerpersons_searchpersons_lookuppersons_find_emailpersons_find_phonewebsites_find_contactswebsites_find_pixelscontacts_createcampaigns_createcampaigns_updatecampaigns_set_statuscampaigns_add_recipientscampaign_ideas_suggestcampaign_ideas_set_audiencecampaign_ideas_set_radiuscampaign_ideas_launchcampaign_ideas_deletedeliverability_create_test
Checks and signals
Each line is separate evidence, not a trust score.
- Passed Endpoint answered the live check ·
- Passed Official MCP Registry namespace is tied to deeplead.io ·
- Passed Endpoint is on the registry namespace domain ·
- Availability 1 of 1 checks passed in 30 days
What you can do with it
- Search local businesses and organizations for lead generation
- Find decision-makers with verified work emails and phone numbers
- Create and manage cold email campaigns from warmed-up inboxes
- Enrich company data and find published website contacts
Source and maintenance
Vendor evidenceRegistry 1.1.0
Protocol and capabilities
- Server
- Deeplead 1.1.1
- MCP protocol negotiated in check
- 2025-11-25
- Tools
- 28 advertised
- Resources
- Not advertised
- Resource templates
- Not advertised
- Prompts
- Not advertised
Server-advertised capabilities
{
"tools": {}
}Tools
28 advertised
businesses_search — Search local businesses from Google Business Profiles
Search local businesses from Google Business Profiles. 23M+ businesses with ratings, reviews, website contacts, socials and ad pixels. 30 per page. Charges 1 credit per business with an email or phone and 0.5 per business without. saveToContacts also stores them in your contacts.
businesses_search input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"categories",
"location"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"maximum": 100,
"minimum": 1,
"description": "Page number, starting at 1; up to 30 businesses per page"
},
"rating": {
"enum": [
"under-4",
"4-to-4.5",
"4.5-plus"
],
"type": "string",
"description": "Google rating band to match"
},
"keyword": {
"type": "string",
"description": "Matched against the business name and categories"
},
"require": {
"type": "object",
"description": "e.g. { \"email\": true, \"metaAds\": false }; false matches only businesses checked and found without it",
"propertyNames": {
"enum": [
"metaAds",
"googleAds",
"chatgptAds",
"gAnalytics",
"tiktokPixel",
"claimed",
"website",
"email",
"phone"
],
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"reviews": {
"enum": [
"under-10",
"10-to-100",
"100-plus"
],
"type": "string",
"description": "Google review-count band to match"
},
"location": {
"type": "string",
"minLength": 1,
"description": "A city (\"Austin, TX\"), a US state (\"Texas\") or a country (\"Germany\")"
},
"categories": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 10,
"minItems": 1,
"description": "Google business categories, e.g. [\"Dentist\"]"
},
"radiusMiles": {
"type": "number",
"maximum": 100,
"minimum": 1,
"description": "Around a city; default 30"
},
"saveToContacts": {
"type": "boolean",
"default": false,
"description": "Save returned businesses to your Deeplead contacts"
},
"excludedCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Google business categories to exclude"
}
}
}businesses_search output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"chargedCredits",
"businesses"
],
"properties": {
"businesses": {
"type": "array",
"items": {
"type": "object",
"required": [
"businessId",
"name",
"categories",
"address",
"city",
"country",
"website",
"email",
"emails",
"phone",
"phones",
"rating",
"reviewCount",
"reviewsByStars",
"googleProfileClaimed",
"socials",
"adPixels"
],
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
},
"phones": {
"type": "array",
"items": {
"type": "string"
}
},
"rating": {
"type": [
"number",
"null"
]
},
"address": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"socials": {
"type": "object",
"required": [
"facebook",
"instagram",
"linkedin",
"tiktok"
],
"properties": {
"tiktok": {
"type": [
"string",
"null"
]
},
"facebook": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"instagram": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"website": {
"type": [
"string",
"null"
]
},
"adPixels": {
"type": "object",
"required": [
"meta",
"googleAds",
"googleAnalytics",
"tiktok",
"chatgpt"
],
"properties": {
"meta": {
"type": [
"boolean",
"null"
]
},
"tiktok": {
"type": [
"boolean",
"null"
]
},
"chatgpt": {
"type": [
"boolean",
"null"
]
},
"googleAds": {
"type": [
"boolean",
"null"
]
},
"googleAnalytics": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
},
"businessId": {
"type": "string"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"reviewCount": {
"type": [
"number",
"null"
]
},
"reviewsByStars": {
"type": "array",
"items": {
"type": [
"number",
"null"
]
},
"description": "Counts of 1 to 5 star reviews"
},
"googleProfileClaimed": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": false
}businesses_search annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}organizations_search — Search organizations, or look them up by domain
Search organizations, or look them up by domain. Charges 0.5 credits per returned organization. limit 0 returns only totalCount, free.
organizations_search input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"default": 25,
"maximum": 25,
"minimum": 0,
"description": "Maximum companies to return; 0 returns only a free count"
},
"query": {
"type": "string",
"minLength": 1,
"description": "Free text matched against company name, description and keywords"
},
"hqCity": {
"type": "array",
"items": {
"type": "string"
},
"description": "City names of the headquarters, e.g. [\"Austin\"]"
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 10000,
"minimum": 0,
"description": "Number of matching companies to skip for pagination"
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 100,
"description": "Look companies up by domain, e.g. [\"stripe.com\"]"
},
"hqState": {
"type": "array",
"items": {
"type": "string"
},
"description": "US state names or codes of the headquarters"
},
"semantic": {
"type": "string",
"minLength": 1,
"description": "What the company is and sells, matched by meaning, e.g. \"outsourced medical billing for clinics\""
},
"hqCountry": {
"type": "array",
"items": {
"type": "string"
},
"description": "ISO alpha-2 country codes of the headquarters, e.g. [\"US\", \"DE\"]"
},
"fundedAfter": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Year of the last funding round, at least; known for about 1 in 100 US companies"
},
"foundedAfter": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Earliest founding year to include"
},
"revenueRange": {
"type": "array",
"items": {
"enum": [
"<$1M",
"$1M to <$10M",
"$10M to <$50M",
"$50M to <$100M",
"$100M to <$1B",
"$1B+"
],
"type": "string"
},
"description": "Annual company revenue bands"
},
"technologies": {
"type": "array",
"items": {
"type": "string"
},
"description": "Technologies used by the company"
},
"employeeBands": {
"type": "array",
"items": {
"enum": [
"1-10",
"11-50",
"51-200",
"201-500",
"501-1,000",
"1,001-5,000",
"5,001-10,000",
"10,001+"
],
"type": "string"
},
"description": "Headcount bands"
},
"foundedBefore": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Latest founding year to include"
},
"monthlyVisitsMin": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Minimum monthly website visits; known for about 1 in 8 US companies, the rest are excluded"
},
"employeeGrowthMin": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Minimum employee growth on LinkedIn in percent, e.g. 10; known for about 1 in 13 US companies"
},
"industryNaicsDirect": {
"type": "array",
"items": {
"type": "string"
},
"description": "NAICS codes"
},
"includeWithoutWebsite": {
"type": "boolean",
"default": false,
"description": "Include companies without websites in search results"
}
}
}organizations_search output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"totalCount",
"chargedCredits",
"organizations"
],
"properties": {
"totalCount": {
"type": "number"
},
"organizations": {
"type": "array",
"items": {
"type": "object",
"required": [
"organizationId",
"name",
"domain",
"website",
"websiteAlive",
"websiteTitle",
"websiteDescription",
"linkedin",
"linkedinDescription",
"description",
"industry",
"naicsCodes",
"keywords",
"technologies",
"employeeCount",
"employeeMin",
"employeeMax",
"revenueRange",
"monthlyVisits",
"monthlyGoogleAdSpend",
"employeeGrowthRate",
"lastFunding",
"totalFunding",
"foundedYear",
"hqCity",
"hqState",
"hqCountry",
"emails",
"phones",
"socials",
"adPixels"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"domain": {
"type": [
"string",
"null"
]
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Found on the company website"
},
"hqCity": {
"type": [
"string",
"null"
]
},
"phones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Found on the company website"
},
"hqState": {
"type": [
"string",
"null"
]
},
"socials": {
"type": "object",
"required": [
"facebook",
"instagram",
"linkedin",
"x",
"tiktok",
"youtube"
],
"properties": {
"x": {
"type": [
"string",
"null"
]
},
"tiktok": {
"type": [
"string",
"null"
]
},
"youtube": {
"type": [
"string",
"null"
]
},
"facebook": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"instagram": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"website": {
"type": [
"string",
"null"
]
},
"adPixels": {
"type": "object",
"required": [
"meta",
"googleAds",
"googleAnalytics",
"tiktok",
"chatgpt"
],
"properties": {
"meta": {
"type": [
"boolean",
"null"
]
},
"tiktok": {
"type": [
"boolean",
"null"
]
},
"chatgpt": {
"type": [
"boolean",
"null"
]
},
"googleAds": {
"type": [
"boolean",
"null"
]
},
"googleAnalytics": {
"type": [
"boolean",
"null"
]
}
},
"description": "true/false where the website was checked, null where it never was",
"additionalProperties": false
},
"industry": {
"type": [
"string",
"null"
]
},
"keywords": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"hqCountry": {
"type": [
"string",
"null"
]
},
"naicsCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": [
"string",
"null"
]
},
"employeeMax": {
"type": [
"number",
"null"
]
},
"employeeMin": {
"type": [
"number",
"null"
]
},
"foundedYear": {
"type": [
"number",
"null"
]
},
"lastFunding": {
"type": "object",
"required": [
"type",
"date",
"amount"
],
"properties": {
"date": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
],
"description": "e.g. Seed Round, Series A, Private Equity Round"
},
"amount": {
"type": [
"number",
"null"
],
"description": "USD"
}
},
"additionalProperties": false
},
"revenueRange": {
"type": [
"string",
"null"
]
},
"technologies": {
"type": [
"string",
"null"
]
},
"totalFunding": {
"type": [
"number",
"null"
],
"description": "USD"
},
"websiteAlive": {
"type": [
"boolean",
"null"
]
},
"websiteTitle": {
"type": [
"string",
"null"
]
},
"employeeCount": {
"type": [
"number",
"null"
]
},
"monthlyVisits": {
"type": [
"number",
"null"
],
"description": "Estimated monthly website visits"
},
"organizationId": {
"type": "string"
},
"employeeGrowthRate": {
"type": [
"number",
"null"
],
"description": "Employee growth on LinkedIn in percent"
},
"websiteDescription": {
"type": [
"string",
"null"
]
},
"linkedinDescription": {
"type": [
"string",
"null"
]
},
"monthlyGoogleAdSpend": {
"type": [
"number",
"null"
],
"description": "Estimated monthly Google Ads spend in USD"
}
},
"additionalProperties": false
}
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": false
}organizations_search annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}organizations_enrich — Enrich a company from its domain
Enrich a company from its domain. Returns the company's firmographics, socials and website data. Charges 0.5 credits only when the company is found.
organizations_enrich input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"minLength": 3,
"description": "Company domain or website URL, e.g. \"stripe.com\""
}
}
}organizations_enrich output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"found",
"chargedCredits",
"organization"
],
"properties": {
"found": {
"type": "boolean"
},
"organization": {
"anyOf": [
{
"type": "object",
"required": [
"organizationId",
"name",
"domain",
"website",
"websiteAlive",
"websiteTitle",
"websiteDescription",
"linkedin",
"linkedinDescription",
"description",
"industry",
"naicsCodes",
"keywords",
"technologies",
"employeeCount",
"employeeMin",
"employeeMax",
"revenueRange",
"monthlyVisits",
"monthlyGoogleAdSpend",
"employeeGrowthRate",
"lastFunding",
"totalFunding",
"foundedYear",
"hqCity",
"hqState",
"hqCountry",
"emails",
"phones",
"socials",
"adPixels"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"domain": {
"type": [
"string",
"null"
]
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Found on the company website"
},
"hqCity": {
"type": [
"string",
"null"
]
},
"phones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Found on the company website"
},
"hqState": {
"type": [
"string",
"null"
]
},
"socials": {
"type": "object",
"required": [
"facebook",
"instagram",
"linkedin",
"x",
"tiktok",
"youtube"
],
"properties": {
"x": {
"type": [
"string",
"null"
]
},
"tiktok": {
"type": [
"string",
"null"
]
},
"youtube": {
"type": [
"string",
"null"
]
},
"facebook": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"instagram": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"website": {
"type": [
"string",
"null"
]
},
"adPixels": {
"type": "object",
"required": [
"meta",
"googleAds",
"googleAnalytics",
"tiktok",
"chatgpt"
],
"properties": {
"meta": {
"type": [
"boolean",
"null"
]
},
"tiktok": {
"type": [
"boolean",
"null"
]
},
"chatgpt": {
"type": [
"boolean",
"null"
]
},
"googleAds": {
"type": [
"boolean",
"null"
]
},
"googleAnalytics": {
"type": [
"boolean",
"null"
]
}
},
"description": "true/false where the website was checked, null where it never was",
"additionalProperties": false
},
"industry": {
"type": [
"string",
"null"
]
},
"keywords": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"hqCountry": {
"type": [
"string",
"null"
]
},
"naicsCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": [
"string",
"null"
]
},
"employeeMax": {
"type": [
"number",
"null"
]
},
"employeeMin": {
"type": [
"number",
"null"
]
},
"foundedYear": {
"type": [
"number",
"null"
]
},
"lastFunding": {
"type": "object",
"required": [
"type",
"date",
"amount"
],
"properties": {
"date": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
],
"description": "e.g. Seed Round, Series A, Private Equity Round"
},
"amount": {
"type": [
"number",
"null"
],
"description": "USD"
}
},
"additionalProperties": false
},
"revenueRange": {
"type": [
"string",
"null"
]
},
"technologies": {
"type": [
"string",
"null"
]
},
"totalFunding": {
"type": [
"number",
"null"
],
"description": "USD"
},
"websiteAlive": {
"type": [
"boolean",
"null"
]
},
"websiteTitle": {
"type": [
"string",
"null"
]
},
"employeeCount": {
"type": [
"number",
"null"
]
},
"monthlyVisits": {
"type": [
"number",
"null"
],
"description": "Estimated monthly website visits"
},
"organizationId": {
"type": "string"
},
"employeeGrowthRate": {
"type": [
"number",
"null"
],
"description": "Employee growth on LinkedIn in percent"
},
"websiteDescription": {
"type": [
"string",
"null"
]
},
"linkedinDescription": {
"type": [
"string",
"null"
]
},
"monthlyGoogleAdSpend": {
"type": [
"number",
"null"
],
"description": "Estimated monthly Google Ads spend in USD"
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": false
}organizations_enrich annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}organizations_find_decision_maker — Find the decision maker of an organization with a verified email
Open-world
Find the decision maker of an organization with a verified email. Charges 2 credits only when a decision maker is found. Can take a few minutes.
organizations_find_decision_maker input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"organizationId"
],
"properties": {
"organizationId": {
"type": "string",
"minLength": 1,
"description": "Company ID returned by organization search or enrichment"
}
}
}organizations_find_decision_maker output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"found",
"creditsCharged",
"decisionMaker"
],
"properties": {
"found": {
"type": "boolean"
},
"decisionMaker": {
"anyOf": [
{
"type": "object",
"required": [
"name",
"position",
"linkedin",
"email"
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"linkedin": {
"type": "string"
},
"position": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"creditsCharged": {
"type": "number"
}
},
"additionalProperties": false
}organizations_find_decision_maker annotations
{
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": false
}persons_search — Search persons with their emails and phones
Search persons with their emails and phones. Covers professional contacts only: people in their role at a company, not private individuals. Returns only people with an email or phone, with full contact data, and charges 1 credit per returned person. Page with nextOffset. limit 0 returns only totalCount, free. saveToContacts also stores them in your contacts, where people you already had are refunded.
persons_search input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 0,
"description": "Maximum people to return; 0 returns only a free count"
},
"query": {
"type": "string",
"minLength": 1,
"description": "Free text matched against company name, description and keywords"
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 10000,
"minimum": 0,
"description": "Pagination offset; use nextOffset from the previous response"
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 100,
"description": "Look companies up by domain, e.g. [\"stripe.com\"]"
},
"hqState": {
"type": "array",
"items": {
"type": "string"
},
"description": "US state names or codes of the headquarters"
},
"jobLevel": {
"type": "array",
"items": {
"enum": [
"C-Team",
"VP",
"Director",
"Manager",
"Staff",
"Other"
],
"type": "string"
},
"description": "Allowed job seniority levels"
},
"jobTitle": {
"type": "array",
"items": {
"type": "string"
},
"description": "Matched as partial text, so \"CEO\" also finds \"Assistant to the CEO\"; combine with jobLevel to narrow"
},
"semantic": {
"type": "string",
"minLength": 1,
"description": "What the company is and sells, matched by meaning, e.g. \"outsourced medical billing for clinics\""
},
"hqCountry": {
"type": "array",
"items": {
"type": "string"
},
"description": "ISO alpha-2 country codes of the headquarters, e.g. [\"US\", \"DE\"]"
},
"inCountry": {
"type": "array",
"items": {
"type": "string"
},
"description": "ISO alpha-2 country codes where the person is based"
},
"personCity": {
"type": "array",
"items": {
"type": "string"
},
"description": "Cities where the person is based"
},
"fundedAfter": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Year of the last funding round, at least; known for about 1 in 100 US companies"
},
"personState": {
"type": "array",
"items": {
"type": "string"
},
"description": "States where the person is based"
},
"foundedAfter": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Earliest founding year to include"
},
"revenueRange": {
"type": "array",
"items": {
"enum": [
"<$1M",
"$1M to <$10M",
"$10M to <$50M",
"$50M to <$100M",
"$100M to <$1B",
"$1B+"
],
"type": "string"
},
"description": "Annual company revenue bands"
},
"technologies": {
"type": "array",
"items": {
"type": "string"
},
"description": "Technologies used by the company"
},
"employeeBands": {
"type": "array",
"items": {
"enum": [
"1-10",
"11-50",
"51-200",
"201-500",
"501-1,000",
"1,001-5,000",
"5,001-10,000",
"10,001+"
],
"type": "string"
},
"description": "Headcount bands"
},
"foundedBefore": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Latest founding year to include"
},
"saveToContacts": {
"type": "boolean",
"default": false,
"description": "Save returned people to your Deeplead contacts"
},
"jobTitleExclude": {
"type": "array",
"items": {
"type": "string"
},
"description": "Job title phrases to exclude"
},
"organizationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Limit to organizations from organizations_search"
},
"monthlyVisitsMin": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Minimum monthly website visits; known for about 1 in 8 US companies, the rest are excluded"
},
"employeeGrowthMin": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Minimum employee growth on LinkedIn in percent, e.g. 10; known for about 1 in 13 US companies"
},
"decisionMakersOnly": {
"type": "boolean",
"description": "C-level, VP or director seniority, or a founder, owner, CEO, managing director or president title"
},
"onePerOrganization": {
"type": "boolean",
"default": false,
"description": "Return at most one person per company"
},
"industryNaicsDirect": {
"type": "array",
"items": {
"type": "string"
},
"description": "NAICS codes"
}
}
}persons_search output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"totalCount",
"nextOffset",
"chargedCredits",
"persons"
],
"properties": {
"persons": {
"type": "array",
"items": {
"type": "object",
"required": [
"personId",
"name",
"email",
"alternateEmails",
"phone",
"phones",
"linkedin",
"jobTitle",
"jobLevel",
"jobFunction",
"city",
"state",
"country",
"organizationId",
"companyName",
"companyWebsite",
"revenueRange",
"naicsCodes",
"foundedYear",
"companyMonthlyVisits",
"companyEmployeeGrowthRate",
"companyLastFundingType",
"companyLastFundingDate"
],
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"phones": {
"type": "array",
"items": {
"type": "string"
}
},
"country": {
"type": [
"string",
"null"
]
},
"jobLevel": {
"type": [
"string",
"null"
]
},
"jobTitle": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"personId": {
"type": [
"string",
"null"
]
},
"naicsCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"companyName": {
"type": [
"string",
"null"
]
},
"foundedYear": {
"type": [
"number",
"null"
]
},
"jobFunction": {
"type": [
"string",
"null"
]
},
"revenueRange": {
"type": [
"string",
"null"
]
},
"companyWebsite": {
"type": [
"string",
"null"
]
},
"organizationId": {
"type": [
"string",
"null"
]
},
"alternateEmails": {
"type": "array",
"items": {
"type": "string"
}
},
"companyMonthlyVisits": {
"type": [
"number",
"null"
]
},
"companyLastFundingDate": {
"type": [
"string",
"null"
]
},
"companyLastFundingType": {
"type": [
"string",
"null"
]
},
"companyEmployeeGrowthRate": {
"type": [
"number",
"null"
],
"description": "Percent"
}
},
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
},
"totalCount": {
"type": "number",
"description": "With limit 0: all matching people, including those without an email or phone"
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": false
}persons_search annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}persons_lookup — Look up one person by LinkedIn URL, email, or name and company domain
Look up one person by LinkedIn URL, email, or name and company domain. Returns the person with their emails, phones, role and company. Covers professional contacts only: people in their role at a company, not private individuals. Charges 1 credit only when the person is found with an email or phone. saveToContacts also stores them in your contacts.
persons_lookup input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"minLength": 3,
"description": "Full name, e.g. \"Jane Doe\"; needs domain"
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Known email address identifying the person"
},
"domain": {
"type": "string",
"minLength": 3,
"description": "Company domain, e.g. \"acme.com\""
},
"linkedin": {
"type": "string",
"minLength": 1,
"description": "e.g. \"https://www.linkedin.com/in/jane-doe\""
},
"saveToContacts": {
"type": "boolean",
"default": false,
"description": "Save the returned person to your Deeplead contacts"
}
}
}persons_lookup output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"found",
"chargedCredits",
"person"
],
"properties": {
"found": {
"type": "boolean"
},
"person": {
"anyOf": [
{
"type": "object",
"required": [
"personId",
"name",
"email",
"alternateEmails",
"phone",
"phones",
"linkedin",
"jobTitle",
"jobLevel",
"jobFunction",
"city",
"state",
"country",
"organizationId",
"companyName",
"companyWebsite",
"revenueRange",
"naicsCodes",
"foundedYear",
"companyMonthlyVisits",
"companyEmployeeGrowthRate",
"companyLastFundingType",
"companyLastFundingDate"
],
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"phones": {
"type": "array",
"items": {
"type": "string"
}
},
"country": {
"type": [
"string",
"null"
]
},
"jobLevel": {
"type": [
"string",
"null"
]
},
"jobTitle": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"personId": {
"type": [
"string",
"null"
]
},
"naicsCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"companyName": {
"type": [
"string",
"null"
]
},
"foundedYear": {
"type": [
"number",
"null"
]
},
"jobFunction": {
"type": [
"string",
"null"
]
},
"revenueRange": {
"type": [
"string",
"null"
]
},
"companyWebsite": {
"type": [
"string",
"null"
]
},
"organizationId": {
"type": [
"string",
"null"
]
},
"alternateEmails": {
"type": "array",
"items": {
"type": "string"
}
},
"companyMonthlyVisits": {
"type": [
"number",
"null"
]
},
"companyLastFundingDate": {
"type": [
"string",
"null"
]
},
"companyLastFundingType": {
"type": [
"string",
"null"
]
},
"companyEmployeeGrowthRate": {
"type": [
"number",
"null"
],
"description": "Percent"
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": false
}persons_lookup annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}persons_find_email — Find a person's work email by LinkedIn URL, or full name and company domain
Find a person's work email by LinkedIn URL, or full name and company domain. Charges 1 credit only when an email is found.
persons_find_email input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"minLength": 3,
"description": "Full name, e.g. \"Jane Doe\"; needs domain"
},
"domain": {
"type": "string",
"minLength": 3,
"description": "Company domain, e.g. \"acme.com\""
},
"linkedin": {
"type": "string",
"minLength": 1,
"description": "e.g. \"https://www.linkedin.com/in/jane-doe\""
}
}
}persons_find_email output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"found",
"chargedCredits",
"email",
"alternateEmails",
"name",
"jobTitle",
"companyName",
"companyWebsite",
"linkedin"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"found": {
"type": "boolean"
},
"jobTitle": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"companyName": {
"type": [
"string",
"null"
]
},
"chargedCredits": {
"type": "number"
},
"companyWebsite": {
"type": [
"string",
"null"
]
},
"alternateEmails": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}persons_find_email annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}persons_find_phone — Find a person's phone number by LinkedIn URL, email, or full name and company domain
Find a person's phone number by LinkedIn URL, email, or full name and company domain. Covers professional contacts only: people in their role at a company, not private individuals. Charges 2 credits only when a phone number is found.
persons_find_phone input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"minLength": 3,
"description": "Full name, e.g. \"Jane Doe\"; needs domain"
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Known email address identifying the person"
},
"domain": {
"type": "string",
"minLength": 3,
"description": "Company domain, e.g. \"acme.com\""
},
"linkedin": {
"type": "string",
"minLength": 1,
"description": "e.g. \"https://www.linkedin.com/in/jane-doe\""
}
}
}persons_find_phone output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"found",
"chargedCredits",
"phone",
"phones",
"name",
"jobTitle",
"companyName",
"companyWebsite",
"linkedin"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"found": {
"type": "boolean"
},
"phone": {
"type": [
"string",
"null"
]
},
"phones": {
"type": "array",
"items": {
"type": "string"
}
},
"jobTitle": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"companyName": {
"type": [
"string",
"null"
]
},
"chargedCredits": {
"type": "number"
},
"companyWebsite": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}persons_find_phone annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}websites_find_contacts — Find the emails, phones and social profiles published on a company website
Find the emails, phones and social profiles published on a company website. Reads what our own crawl of the website found, so it answers in under a second and never visits the site during the call. A website that many businesses share (a site builder, a booking platform) has no contacts. Charges 0.5 credits only when an email or phone is found.
websites_find_contacts input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"website"
],
"properties": {
"website": {
"type": "string",
"minLength": 3,
"description": "Website URL or domain, e.g. \"castledental.com\""
}
}
}websites_find_contacts output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"emails",
"phones",
"socials",
"found",
"chargedCredits",
"website"
],
"properties": {
"found": {
"type": "boolean",
"description": "true when an email or phone was found"
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Found on the company website"
},
"phones": {
"type": "array",
"items": {
"type": "string"
},
"description": "Found on the company website"
},
"socials": {
"type": "object",
"required": [
"facebook",
"instagram",
"linkedin",
"x",
"tiktok",
"youtube"
],
"properties": {
"x": {
"type": [
"string",
"null"
]
},
"tiktok": {
"type": [
"string",
"null"
]
},
"youtube": {
"type": [
"string",
"null"
]
},
"facebook": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"instagram": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"website": {
"type": "string",
"description": "The domain that was looked up"
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": false
}websites_find_contacts annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}websites_find_pixels — Find the ad and analytics pixels a website runs
Open-world
Find the ad and analytics pixels a website runs. Checks the homepage and every Google Tag Manager container it loads, nested ones included, for meta, tiktok, openai, google_analytics, google_ads, microsoft_ads, linkedin, pinterest, snapchat, x, reddit, hotjar, microsoft_clarity, callrail. Containers that 50 or more websites load belong to a platform or agency and are left out. Answers from the last check when the website was checked before (checkedAt), otherwise checks it during the call, which can take up to 20 seconds. Charges 0.25 credits when the homepage answered, also when it runs no pixels; a homepage that never answers is free.
websites_find_pixels input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"website"
],
"properties": {
"website": {
"type": "string",
"minLength": 3,
"description": "Website URL or domain, e.g. \"castledental.com\""
}
}
}websites_find_pixels output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"found",
"chargedCredits",
"website",
"pixels",
"pixelIds",
"checkedAt"
],
"properties": {
"found": {
"type": "boolean",
"description": "true when the homepage answered and was checked"
},
"pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Vendors whose pixel or tag runs on the website, e.g. meta, google_ads"
},
"website": {
"type": "string",
"description": "The domain that was checked"
},
"pixelIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "vendor:id where the markup shows the id, e.g. \"meta:1234567890\" or \"google_ads:AW-123456789\""
},
"checkedAt": {
"type": [
"string",
"null"
]
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": false
}websites_find_pixels annotations
{
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": false
}contacts_create — Save your own contacts or organizations
Save your own contacts or organizations. Free. Existing contacts are matched and kept, never duplicated.
contacts_create input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contacts"
],
"properties": {
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"phone": {
"type": "string"
},
"website": {
"type": "string"
},
"industry": {
"type": "string"
},
"linkedin": {
"type": "string"
},
"position": {
"type": "string"
},
"personName": {
"type": "string"
},
"businessName": {
"type": "string"
},
"organizationId": {
"type": "string",
"description": "From organizations_search"
}
}
},
"maxItems": 1000,
"minItems": 1,
"description": "Contacts to save; each needs an email, LinkedIn URL, website or organization ID"
}
}
}contacts_create output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"saved"
],
"properties": {
"saved": {
"type": "number"
}
},
"additionalProperties": false
}contacts_create annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}contacts_list — List your contacts in a stable order; page with nextBefore
Advertised read-only
List your contacts in a stable order; page with nextBefore
contacts_list input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"default": 100,
"maximum": 500,
"minimum": 1,
"description": "Maximum saved contacts to return on this page"
},
"before": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "The nextBefore of the previous page"
}
}
}contacts_list output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contacts",
"nextBefore"
],
"properties": {
"contacts": {
"type": "array",
"items": {
"type": "object",
"required": [
"contactId",
"name",
"email",
"jobTitle",
"companyName",
"website",
"linkedin",
"organizationId"
],
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"website": {
"type": [
"string",
"null"
]
},
"jobTitle": {
"type": [
"string",
"null"
]
},
"linkedin": {
"type": [
"string",
"null"
]
},
"contactId": {
"type": "string"
},
"companyName": {
"type": [
"string",
"null"
]
},
"organizationId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"nextBefore": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}contacts_list annotations
{
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}campaigns_list — List your email campaigns, newest first, with their status and counts
Advertised read-only
List your email campaigns, newest first, with their status and counts
campaigns_list input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"includeArchived": {
"enum": [
"true",
"false"
],
"type": "string",
"default": "false",
"description": "Also list archived campaigns"
}
}
}campaigns_list output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"campaigns"
],
"properties": {
"campaigns": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"name",
"status",
"campaignIdeaId",
"counts"
],
"properties": {
"name": {
"type": "string"
},
"counts": {
"type": "object",
"required": [
"recipients",
"sent",
"replied",
"bounced",
"finished"
],
"properties": {
"sent": {
"type": "number"
},
"bounced": {
"type": "number"
},
"replied": {
"type": "number"
},
"finished": {
"type": "number",
"description": "Recipients who had every step"
},
"recipients": {
"type": "number"
}
},
"additionalProperties": false
},
"status": {
"enum": [
"draft",
"active",
"credits_exhausted",
"paused",
"completed",
"error",
"archived",
"invalid"
],
"type": "string"
},
"campaignId": {
"type": "string"
},
"campaignIdeaId": {
"type": [
"string",
"null"
],
"description": "ideaId from campaign_ideas_list this campaign was launched from"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}campaigns_list annotations
{
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}campaigns_get — One campaign with its steps, sender pool and counts
Advertised read-only
One campaign with its steps, sender pool and counts
campaigns_get input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"campaignId"
],
"properties": {
"campaignId": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "campaignId from campaigns_create"
}
}
}campaigns_get output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"campaignId",
"name",
"status",
"campaignIdeaId",
"counts",
"poolId",
"dailySendingLimit",
"steps"
],
"properties": {
"name": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"subject",
"body",
"waitDays",
"variations"
],
"properties": {
"id": {
"type": "string"
},
"body": {
"type": "string"
},
"subject": {
"type": "string"
},
"waitDays": {
"type": [
"number",
"null"
]
},
"variations": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"subject",
"body",
"weight"
],
"properties": {
"id": {
"type": "string"
},
"body": {
"type": "string"
},
"weight": {
"type": "number"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"counts": {
"type": "object",
"required": [
"recipients",
"sent",
"replied",
"bounced",
"finished"
],
"properties": {
"sent": {
"type": "number"
},
"bounced": {
"type": "number"
},
"replied": {
"type": "number"
},
"finished": {
"type": "number",
"description": "Recipients who had every step"
},
"recipients": {
"type": "number"
}
},
"additionalProperties": false
},
"poolId": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"draft",
"active",
"credits_exhausted",
"paused",
"completed",
"error",
"archived",
"invalid"
],
"type": "string"
},
"campaignId": {
"type": "string"
},
"campaignIdeaId": {
"type": [
"string",
"null"
],
"description": "ideaId from campaign_ideas_list this campaign was launched from"
},
"dailySendingLimit": {
"type": [
"number",
"null"
]
}
},
"additionalProperties": false
}campaigns_get annotations
{
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}campaigns_create — Create an email campaign; it starts paused
Create an email campaign; it starts paused. Free. Add recipients with campaigns_add_recipients, then turn it on with campaigns_set_status.
campaigns_create input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"steps"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"subject",
"body"
],
"properties": {
"id": {
"type": "string",
"description": "The step id from campaigns_update; keeps its personalization and past versions"
},
"body": {
"type": "string",
"description": "Links are allowed, and the editor warns about them. Leave out a link to the sender's own site or a booking page: a free trial or test drive is offered in words (\"five free reports on our test drive\"), and the link goes out once the recipient replies. Naming the recipient's own site (\"I was on smilecare.com earlier\") is fine."
},
"subject": {
"type": "string",
"description": "Links are allowed, and the editor warns about them. Leave out a link to the sender's own site or a booking page: a free trial or test drive is offered in words (\"five free reports on our test drive\"), and the link goes out once the recipient replies. Naming the recipient's own site (\"I was on smilecare.com earlier\") is fine."
},
"waitDays": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Days after the previous step; ignored on step 1"
},
"variations": {
"type": "array",
"items": {
"type": "object",
"required": [
"subject",
"body",
"weight"
],
"properties": {
"id": {
"type": "string",
"description": "Keep it to keep this variation; leave it out for a new one"
},
"body": {
"type": "string",
"description": "Links are allowed, and the editor warns about them. Leave out a link to the sender's own site or a booking page: a free trial or test drive is offered in words (\"five free reports on our test drive\"), and the link goes out once the recipient replies. Naming the recipient's own site (\"I was on smilecare.com earlier\") is fine."
},
"weight": {
"type": "number",
"minimum": 0,
"description": "Share of recipients relative to the step default and the other variations"
},
"subject": {
"type": "string",
"description": "Links are allowed, and the editor warns about them. Leave out a link to the sender's own site or a booking page: a free trial or test drive is offered in words (\"five free reports on our test drive\"), and the link goes out once the recipient replies. Naming the recipient's own site (\"I was on smilecare.com earlier\") is fine."
}
}
}
}
}
},
"maxItems": 10,
"minItems": 1,
"description": "The first email and its follow-ups, in order"
},
"poolId": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Sender pool to send from; by default the pool with the most inboxes, else Shared Inboxes"
},
"dailySendingLimit": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Emails a day at most; null for none"
}
}
}campaigns_create output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"campaignId",
"name",
"status",
"campaignIdeaId",
"counts",
"poolId",
"dailySendingLimit",
"steps"
],
"properties": {
"name": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"subject",
"body",
"waitDays",
"variations"
],
"properties": {
"id": {
"type": "string"
},
"body": {
"type": "string"
},
"subject": {
"type": "string"
},
"waitDays": {
"type": [
"number",
"null"
]
},
"variations": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"subject",
"body",
"weight"
],
"properties": {
"id": {
"type": "string"
},
"body": {
"type": "string"
},
"weight": {
"type": "number"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"counts": {
"type": "object",
"required": [
"recipients",
"sent",
"replied",
"bounced",
"finished"
],
"properties": {
"sent": {
"type": "number"
},
"bounced": {
"type": "number"
},
"replied": {
"type": "number"
},
"finished": {
"type": "number",
"description": "Recipients who had every step"
},
"recipients": {
"type": "number"
}
},
"additionalProperties": false
},
"poolId": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"draft",
"active",
"credits_exhausted",
"paused",
"completed",
"error",
"archived",
"invalid"
],
"type": "string"
},
"campaignId": {
"type": "string"
},
"campaignIdeaId": {
"type": [
"string",
"null"
],
"description": "ideaId from campaign_ideas_list this campaign was launched from"
},
"dailySendingLimit": {
"type": [
"number",
"null"
]
}
},
"additionalProperties": false
}campaigns_create annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}campaigns_update — Change a campaign’s name, steps, sender pool or daily limit
Change a campaign’s name, steps, sender pool or daily limit. Only the fields sent change. steps replaces every step: send a step with its id to keep its personalization and past versions.
campaigns_update input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"campaignId"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"subject",
"body"
],
"properties": {
"id": {
"type": "string",
"description": "The step id from campaigns_update; keeps its personalization and past versions"
},
"body": {
"type": "string",
"description": "Links are allowed, and the editor warns about them. Leave out a link to the sender's own site or a booking page: a free trial or test drive is offered in words (\"five free reports on our test drive\"), and the link goes out once the recipient replies. Naming the recipient's own site (\"I was on smilecare.com earlier\") is fine."
},
"subject": {
"type": "string",
"description": "Links are allowed, and the editor warns about them. Leave out a link to the sender's own site or a booking page: a free trial or test drive is offered in words (\"five free reports on our test drive\"), and the link goes out once the recipient replies. Naming the recipient's own site (\"I was on smilecare.com earlier\") is fine."
},
"waitDays": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Days after the previous step; ignored on step 1"
},
"variations": {
"type": "array",
"items": {
"type": "object",
"required": [
"subject",
"body",
"weight"
],
"properties": {
"id": {
"type": "string",
"description": "Keep it to keep this variation; leave it out for a new one"
},
"body": {
"type": "string",
"description": "Links are allowed, and the editor warns about them. Leave out a link to the sender's own site or a booking page: a free trial or test drive is offered in words (\"five free reports on our test drive\"), and the link goes out once the recipient replies. Naming the recipient's own site (\"I was on smilecare.com earlier\") is fine."
},
"weight": {
"type": "number",
"minimum": 0,
"description": "Share of recipients relative to the step default and the other variations"
},
"subject": {
"type": "string",
"description": "Links are allowed, and the editor warns about them. Leave out a link to the sender's own site or a booking page: a free trial or test drive is offered in words (\"five free reports on our test drive\"), and the link goes out once the recipient replies. Naming the recipient's own site (\"I was on smilecare.com earlier\") is fine."
}
}
}
}
}
},
"maxItems": 10,
"minItems": 1
},
"poolId": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Sender pool to send from; by default the pool with the most inboxes, else Shared Inboxes"
},
"campaignId": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "campaignId from campaigns_create"
},
"dailySendingLimit": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Emails a day at most; null for none"
}
}
}campaigns_update output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"campaignId",
"name",
"status",
"campaignIdeaId",
"counts",
"poolId",
"dailySendingLimit",
"steps"
],
"properties": {
"name": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"subject",
"body",
"waitDays",
"variations"
],
"properties": {
"id": {
"type": "string"
},
"body": {
"type": "string"
},
"subject": {
"type": "string"
},
"waitDays": {
"type": [
"number",
"null"
]
},
"variations": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"subject",
"body",
"weight"
],
"properties": {
"id": {
"type": "string"
},
"body": {
"type": "string"
},
"weight": {
"type": "number"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"counts": {
"type": "object",
"required": [
"recipients",
"sent",
"replied",
"bounced",
"finished"
],
"properties": {
"sent": {
"type": "number"
},
"bounced": {
"type": "number"
},
"replied": {
"type": "number"
},
"finished": {
"type": "number",
"description": "Recipients who had every step"
},
"recipients": {
"type": "number"
}
},
"additionalProperties": false
},
"poolId": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"draft",
"active",
"credits_exhausted",
"paused",
"completed",
"error",
"archived",
"invalid"
],
"type": "string"
},
"campaignId": {
"type": "string"
},
"campaignIdeaId": {
"type": [
"string",
"null"
],
"description": "ideaId from campaign_ideas_list this campaign was launched from"
},
"dailySendingLimit": {
"type": [
"number",
"null"
]
}
},
"additionalProperties": false
}campaigns_update annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}campaigns_set_status — Turn a campaign on, pause it, or archive it
Turn a campaign on, pause it, or archive it. active needs a sender pool with an active inbox. Setting paused on an archived campaign unarchives it.
campaigns_set_status input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"campaignId",
"status"
],
"properties": {
"status": {
"enum": [
"active",
"paused",
"archived"
],
"type": "string"
},
"campaignId": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "campaignId from campaigns_create"
}
}
}campaigns_set_status output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"campaignId",
"name",
"status",
"campaignIdeaId",
"counts",
"poolId",
"dailySendingLimit",
"steps"
],
"properties": {
"name": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"subject",
"body",
"waitDays",
"variations"
],
"properties": {
"id": {
"type": "string"
},
"body": {
"type": "string"
},
"subject": {
"type": "string"
},
"waitDays": {
"type": [
"number",
"null"
]
},
"variations": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"subject",
"body",
"weight"
],
"properties": {
"id": {
"type": "string"
},
"body": {
"type": "string"
},
"weight": {
"type": "number"
},
"subject": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"counts": {
"type": "object",
"required": [
"recipients",
"sent",
"replied",
"bounced",
"finished"
],
"properties": {
"sent": {
"type": "number"
},
"bounced": {
"type": "number"
},
"replied": {
"type": "number"
},
"finished": {
"type": "number",
"description": "Recipients who had every step"
},
"recipients": {
"type": "number"
}
},
"additionalProperties": false
},
"poolId": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"draft",
"active",
"credits_exhausted",
"paused",
"completed",
"error",
"archived",
"invalid"
],
"type": "string"
},
"campaignId": {
"type": "string"
},
"campaignIdeaId": {
"type": [
"string",
"null"
],
"description": "ideaId from campaign_ideas_list this campaign was launched from"
},
"dailySendingLimit": {
"type": [
"number",
"null"
]
}
},
"additionalProperties": false
}campaigns_set_status annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}campaigns_add_recipients — Add your contacts to a campaign
Add your contacts to a campaign. Free. Contacts already in the campaign, without a usable email or not among your contacts are skipped.
campaigns_add_recipients input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"campaignId",
"contactIds"
],
"properties": {
"campaignId": {
"type": "string",
"pattern": "^[0-9a-fA-F]{24}$",
"description": "campaignId from campaigns_create"
},
"contactIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-f\\d]{24}$"
},
"maxItems": 1000,
"minItems": 1,
"description": "contactId values from contacts_list"
}
}
}campaigns_add_recipients output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"added",
"skipped"
],
"properties": {
"added": {
"type": "number"
},
"skipped": {
"type": "number"
}
},
"additionalProperties": false
}campaigns_add_recipients annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}campaign_ideas_list — List your campaign ideas and how far each got
Advertised read-only
List your campaign ideas and how far each got. Poll about once a minute while suggesting is true or an idea is drafting or launching.
campaign_ideas_list input schema
{
"type": "object",
"properties": {}
}campaign_ideas_list output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ideas",
"suggesting"
],
"properties": {
"ideas": {
"type": "array",
"items": {
"type": "object",
"required": [
"ideaId",
"type",
"role",
"segment",
"pitch",
"pain",
"play",
"criteria",
"examples",
"categories",
"excludedCategories",
"radiusMiles",
"state",
"campaign"
],
"properties": {
"pain": {
"type": "string"
},
"play": {
"anyOf": [
{
"enum": [
"ideas",
"quote",
"mockup",
"sample",
"fixes",
"video",
"rank",
"breakdown",
"jargon",
"siteCheck",
"referral",
"commission",
"wholesaleSamples"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Which email its campaign writes, e.g. ideas, quote or jargon"
},
"role": {
"anyOf": [
{
"enum": [
"buyer",
"partner",
"stockist"
],
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"enum": [
"smb",
"company",
"signal"
],
"type": "string",
"description": "smb: local businesses from Google Maps; company: companies by industry and size; signal: people on LinkedIn by what they post or engage with"
},
"pitch": {
"type": "string"
},
"state": {
"enum": [
"suggested",
"drafting",
"drafted",
"failed",
"launching",
"launched"
],
"type": "string"
},
"ideaId": {
"type": "string"
},
"segment": {
"type": "string"
},
"campaign": {
"anyOf": [
{
"type": "object",
"required": [
"campaignId",
"kind",
"live"
],
"properties": {
"kind": {
"enum": [
"standard",
"signal"
],
"type": "string"
},
"live": {
"type": "boolean"
},
"campaignId": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "The campaign it launched; kind signal is a LinkedIn signal campaign, not reachable through campaigns_create"
},
"criteria": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"domain"
],
"properties": {
"name": {
"type": "string"
},
"domain": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Google Maps categories of an smb idea; empty otherwise"
},
"radiusMiles": {
"type": [
"number",
"null"
],
"description": "Miles around the home city of an smb idea; null for the default"
},
"excludedCategories": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"suggesting": {
"type": "boolean"
}
},
"additionalProperties": false
}campaign_ideas_list annotations
{
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}campaign_ideas_get — One campaign idea with its draft: audience size and example emails
Advertised read-only
One campaign idea with its draft: audience size and example emails
campaign_ideas_get input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ideaId"
],
"properties": {
"ideaId": {
"type": "string",
"minLength": 1,
"description": "ideaId from campaign_ideas_list"
}
}
}campaign_ideas_get output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ideaId",
"type",
"role",
"segment",
"pitch",
"pain",
"play",
"criteria",
"examples",
"categories",
"excludedCategories",
"radiusMiles",
"state",
"campaign",
"draft"
],
"properties": {
"pain": {
"type": "string"
},
"play": {
"anyOf": [
{
"enum": [
"ideas",
"quote",
"mockup",
"sample",
"fixes",
"video",
"rank",
"breakdown",
"jargon",
"siteCheck",
"referral",
"commission",
"wholesaleSamples"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Which email its campaign writes, e.g. ideas, quote or jargon"
},
"role": {
"anyOf": [
{
"enum": [
"buyer",
"partner",
"stockist"
],
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"enum": [
"smb",
"company",
"signal"
],
"type": "string",
"description": "smb: local businesses from Google Maps; company: companies by industry and size; signal: people on LinkedIn by what they post or engage with"
},
"draft": {
"anyOf": [
{
"type": "object",
"required": [
"audienceSize",
"email",
"examples"
],
"properties": {
"email": {
"type": "object",
"required": [
"subject",
"body"
],
"properties": {
"body": {
"type": "string"
},
"subject": {
"type": "string"
}
},
"description": "The campaign email every recipient starts from",
"additionalProperties": false
},
"examples": {
"type": "array",
"items": {
"type": "object",
"required": [
"subject",
"body",
"recipient"
],
"properties": {
"body": {
"type": "string"
},
"subject": {
"type": "string"
},
"recipient": {
"type": "object",
"required": [
"name",
"company",
"email"
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"company": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"audienceSize": {
"type": "number",
"description": "Estimated recipients"
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Once drafted"
},
"pitch": {
"type": "string"
},
"state": {
"enum": [
"suggested",
"drafting",
"drafted",
"failed",
"launching",
"launched"
],
"type": "string"
},
"ideaId": {
"type": "string"
},
"segment": {
"type": "string"
},
"campaign": {
"anyOf": [
{
"type": "object",
"required": [
"campaignId",
"kind",
"live"
],
"properties": {
"kind": {
"enum": [
"standard",
"signal"
],
"type": "string"
},
"live": {
"type": "boolean"
},
"campaignId": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "The campaign it launched; kind signal is a LinkedIn signal campaign, not reachable through campaigns_create"
},
"criteria": {
"type": "array",
"items": {
"type": "string"
}
},
"examples": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"domain"
],
"properties": {
"name": {
"type": "string"
},
"domain": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Google Maps categories of an smb idea; empty otherwise"
},
"radiusMiles": {
"type": [
"number",
"null"
],
"description": "Miles around the home city of an smb idea; null for the default"
},
"excludedCategories": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}campaign_ideas_get annotations
{
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}campaign_ideas_suggest — Suggest campaign ideas from your company profile
Suggest campaign ideas from your company profile. Free. Answers at once; the ideas show in campaign_ideas_list once suggesting is false, replacing every idea not launched yet. With segment it adds ideas for that audience instead.
campaign_ideas_suggest input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"segment": {
"type": "string",
"maxLength": 300,
"minLength": 3,
"description": "An audience of your own, e.g. \"Dental clinics in Ohio opening a second location\""
}
}
}campaign_ideas_suggest output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"suggesting"
],
"properties": {
"suggesting": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}campaign_ideas_suggest annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}campaign_ideas_set_audience — Set the Google Maps categories a Maps idea reaches
Set the Google Maps categories a Maps idea reaches. On a launched idea, recipients not contacted yet who no longer fit are taken out; removedRecipients counts them.
campaign_ideas_set_audience input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"categories",
"exclude",
"ideaId"
],
"properties": {
"ideaId": {
"type": "string",
"minLength": 1,
"description": "ideaId from campaign_ideas_list"
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 20
},
"categories": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 20,
"minItems": 1
}
}
}campaign_ideas_set_audience output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"removedRecipients"
],
"properties": {
"removedRecipients": {
"type": "number"
}
},
"additionalProperties": false
}campaign_ideas_set_audience annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}campaign_ideas_set_radius — Set how many miles around your home city a Maps idea reaches
Set how many miles around your home city a Maps idea reaches. On a launched idea, recipients not contacted yet outside the new radius are taken out; removedRecipients counts them.
campaign_ideas_set_radius input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ideaId",
"radiusMiles"
],
"properties": {
"ideaId": {
"type": "string",
"minLength": 1,
"description": "ideaId from campaign_ideas_list"
},
"radiusMiles": {
"type": "integer",
"maximum": 100,
"minimum": 5
}
}
}campaign_ideas_set_radius output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"removedRecipients"
],
"properties": {
"removedRecipients": {
"type": "number"
}
},
"additionalProperties": false
}campaign_ideas_set_radius annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}campaign_ideas_launch — Draft each idea, create its campaign and turn it on
Draft each idea, create its campaign and turn it on. Answers at once. Each idea shows launching in campaign_ideas_list, then launched with its campaign once created.
campaign_ideas_launch input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ideaIds"
],
"properties": {
"ideaIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"description": "ideaId from campaign_ideas_list"
},
"maxItems": 20,
"minItems": 1
}
}
}campaign_ideas_launch output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"ideaId",
"launching",
"reason"
],
"properties": {
"ideaId": {
"type": "string"
},
"reason": {
"type": [
"string",
"null"
],
"description": "Why it could not launch"
},
"launching": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}campaign_ideas_launch annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}campaign_ideas_delete — Delete a campaign idea that has no campaign
Advertised destructive
Delete a campaign idea that has no campaign. An idea that launched a campaign, or is launching, stays; archive its campaign instead.
campaign_ideas_delete input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"ideaId"
],
"properties": {
"ideaId": {
"type": "string",
"minLength": 1,
"description": "ideaId from campaign_ideas_list"
}
}
}campaign_ideas_delete output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"deleted"
],
"properties": {
"deleted": {
"type": "boolean",
"const": true
}
},
"additionalProperties": false
}campaign_ideas_delete annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}deliverability_create_test — Start an inbox placement test for a mailbox you send from
Start an inbox placement test for a mailbox you send from. Send one email from the mailbox you want to test to every address in seedEmails, with the testId anywhere in the body, then poll deliverability_get_test about once a minute to see whether it landed in the inbox, spam or a tab at Gmail, Outlook and other providers. Most seeds report within 2-5 minutes; the test closes 60 minutes after it starts. Charges 25 credits.
deliverability_create_test input schema
{
"type": "object",
"properties": {}
}deliverability_create_test output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"testId",
"seedEmails",
"chargedCredits",
"closesAt"
],
"properties": {
"testId": {
"type": "string",
"description": "Put this anywhere in the body of the test email"
},
"closesAt": {
"type": "string"
},
"seedEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Send the test email to every one of these addresses"
},
"chargedCredits": {
"type": "number"
}
},
"additionalProperties": false
}deliverability_create_test annotations
{
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": false
}deliverability_get_test — Where the test email landed at each seed mailbox
Advertised read-only
Where the test email landed at each seed mailbox. Poll about once a minute while status is waiting. placement is inbox, spam, promotions, social, updates or forums, missing while the email has not arrived, or unreadable while we could not read that seed mailbox; score is the inbox share from 0 to 10 once the test is completed, leaving unreadable seeds out. rspamd is the content filter verdict with its matched rules, when a seed reports one.
deliverability_get_test input schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"testId"
],
"properties": {
"testId": {
"type": "string",
"pattern": "^dlt-[0-9a-f]{24}$",
"description": "testId returned by deliverability_create_test"
}
}
}deliverability_get_test output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"testId",
"status",
"closesAt",
"score",
"seeds",
"rspamd"
],
"properties": {
"score": {
"type": [
"number",
"null"
]
},
"seeds": {
"type": "array",
"items": {
"type": "object",
"required": [
"email",
"provider",
"placement"
],
"properties": {
"email": {
"type": "string"
},
"provider": {
"type": "string"
},
"placement": {
"type": "string"
}
},
"additionalProperties": false
}
},
"rspamd": {
"anyOf": [
{
"type": "object",
"required": [
"score",
"requiredScore",
"action",
"symbols"
],
"properties": {
"score": {
"type": "number"
},
"action": {
"type": "string"
},
"symbols": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"score"
],
"properties": {
"name": {
"type": "string"
},
"score": {
"type": "number"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
},
"requiredScore": {
"type": "number"
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"waiting",
"completed"
],
"type": "string"
},
"testId": {
"type": "string"
},
"closesAt": {
"type": "string"
}
},
"additionalProperties": false
}deliverability_get_test annotations
{
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}credits_get — Current credit balance
Advertised read-only
Current credit balance
credits_get input schema
{
"type": "object",
"properties": {}
}credits_get output schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"credits"
],
"properties": {
"credits": {
"type": "number"
}
},
"additionalProperties": false
}credits_get annotations
{
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}Prompts
Not advertised
Resources
Not advertised
90-day uptime
A lightweight connection check about every six hours, sampled on hosts with many listings. It shows the server answered, not that its tools work.
- 2026-11-06: 1 of 1 checks answered
- 2026-11-07: 1 of 1 checks answered
30-day availability
Aggregated from read-only remote checks; this is not a tool-execution or security guarantee.
- Successful checks
- 1 of 1 (100%)
- Average latency
- 1027 ms
- 95th percentile latency
- 1027 ms
Maintenance history
Public check and source-refresh events. Editorial and ownership records remain private.
- · probe · passed · 1027 ms · metadata changed · 28 tool(s)
Connect from your client
Each snippet registers the same endpoint; pick the client you use.
Claude Code
Claude Code configuration
claude mcp add --transport http deeplead-mcp https://www.deeplead.io/api/mcpCodex
Codex configuration
codex mcp add deeplead-mcp --url https://www.deeplead.io/api/mcpCursor
Cursor configuration
{
"mcpServers": {
"deeplead-mcp": {
"url": "https://www.deeplead.io/api/mcp"
}
}
}Cline
Cline configuration
{
"mcpServers": {
"deeplead-mcp": {
"type": "streamableHttp",
"url": "https://www.deeplead.io/api/mcp",
"disabled": false
}
}
}VS Code
VS Code configuration
{
"servers": {
"deeplead-mcp": {
"type": "http",
"url": "https://www.deeplead.io/api/mcp"
}
}
}Gemini CLI
Gemini CLI configuration
gemini mcp add --transport http deeplead-mcp https://www.deeplead.io/api/mcpClaude Desktop
Claude Desktop configuration
https://www.deeplead.io/api/mcpWindsurf
Windsurf configuration
{
"mcpServers": {
"deeplead-mcp": {
"serverUrl": "https://www.deeplead.io/api/mcp"
}
}
}Let your agent find its tools
Find servers like Deeplead MCP from your agent. Add Koskamo once to search the index for endpoints, access requirements, and client setup. Public discovery needs no key.
Other crm, sales, and marketing servers
Do you run Deeplead MCP?
Prove ownership with a DNS record, a well-known file, or your Official MCP Registry entry, and your edits publish immediately. Proofs are re-checked weekly; admins can still hide or remove a listing.