Deeplead API

{"servers":[{"url":"https://www.deeplead.io/api/v1"}],"info":{"title":"Deeplead API","version":"1.0.0","description":"Search local businesses, companies and people, and find decision makers with verified work emails and phone numbers. Authenticate with an API key as a Bearer token; up to 120 requests per minute per account, answered with 429 beyond that.","contact":{"email":"support@deeplead.io","url":"https://www.deeplead.io/developers"},"termsOfService":"https://www.deeplead.io/terms"},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer"}}},"security":[{"apiKey":[]}],"openapi":"3.1.1","paths":{"/businesses/search":{"post":{"operationId":"businesses.search","summary":"Search local businesses from Google Business Profiles","description":"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. Send an Idempotency-Key header to make retries safe.","tags":["Businesses"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","minLength":1},"description":"Google business categories, e.g. [\"Dentist\"]"},"location":{"type":"string","minLength":1,"description":"A city (\"Austin, TX\"), a US state (\"Texas\") or a country (\"Germany\")"},"page":{"type":"integer","minimum":1,"maximum":100,"default":1,"description":"Page number, starting at 1; up to 30 businesses per page"},"radiusMiles":{"type":"number","minimum":1,"maximum":100,"description":"Around a city; default 30"},"keyword":{"type":"string","description":"Matched against the business name and categories"},"excludedCategories":{"type":"array","items":{"type":"string"},"description":"Google business categories to exclude"},"rating":{"enum":["under-4","4-to-4.5","4.5-plus"],"type":"string","description":"Google rating band to match"},"reviews":{"enum":["under-10","10-to-100","100-plus"],"type":"string","description":"Google review-count band to match"},"require":{"type":"object","propertyNames":{"enum":["metaAds","googleAds","chatgptAds","gAnalytics","tiktokPixel","claimed","website","email","phone"],"type":"string"},"additionalProperties":{"type":"boolean"},"description":"e.g. { \"email\": true, \"metaAds\": false }; false matches only businesses checked and found without it"},"saveToContacts":{"type":"boolean","default":false,"description":"Save returned businesses to your Deeplead contacts"}},"required":["categories","location"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"chargedCredits":{"type":"number"},"businesses":{"type":"array","items":{"type":"object","properties":{"businessId":{"type":"string"},"name":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"address":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emails":{"type":"array","items":{"type":"string"}},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phones":{"type":"array","items":{"type":"string"}},"rating":{"anyOf":[{"type":"number"},{"type":"null"}]},"reviewCount":{"anyOf":[{"type":"number"},{"type":"null"}]},"reviewsByStars":{"type":"array","items":{"anyOf":[{"type":"number"},{"type":"null"}]},"description":"Counts of 1 to 5 star reviews"},"googleProfileClaimed":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"socials":{"type":"object","properties":{"facebook":{"anyOf":[{"type":"string"},{"type":"null"}]},"instagram":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}]},"tiktok":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["facebook","instagram","linkedin","tiktok"]},"adPixels":{"type":"object","properties":{"meta":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"googleAds":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"googleAnalytics":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"tiktok":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"chatgpt":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["meta","googleAds","googleAnalytics","tiktok","chatgpt"]}},"required":["businessId","name","categories","address","city","country","website","email","emails","phone","phones","rating","reviewCount","reviewsByStars","googleProfileClaimed","socials","adPixels"]}}},"required":["chargedCredits","businesses"]}}}}}}},"/organizations/search":{"post":{"operationId":"organizations.search","summary":"Search organizations, or look them up by domain","description":"Charges 0.5 credits per returned organization. limit 0 returns only totalCount, free. Send an Idempotency-Key header to make retries safe.","tags":["Organizations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"description":"Free text matched against company name, description and keywords"},"semantic":{"type":"string","minLength":1,"description":"What the company is and sells, matched by meaning, e.g. \"outsourced medical billing for clinics\""},"domains":{"type":"array","maxItems":100,"items":{"type":"string"},"description":"Look companies up by domain, e.g. [\"stripe.com\"]"},"hqCountry":{"type":"array","items":{"type":"string"},"description":"ISO alpha-2 country codes of the headquarters, e.g. [\"US\", \"DE\"]"},"hqState":{"type":"array","items":{"type":"string"},"description":"US state names or codes of the headquarters"},"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"},"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"},"industryNaicsDirect":{"type":"array","items":{"type":"string"},"description":"NAICS codes"},"technologies":{"type":"array","items":{"type":"string"},"description":"Technologies used by the company"},"foundedAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Earliest founding year to include"},"foundedBefore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Latest founding year to include"},"monthlyVisitsMin":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Minimum monthly website visits; known for about 1 in 8 US companies, the rest are excluded"},"employeeGrowthMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum employee growth on LinkedIn in percent, e.g. 10; known for about 1 in 13 US companies"},"fundedAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Year of the last funding round, at least; known for about 1 in 100 US companies"},"hqCity":{"type":"array","items":{"type":"string"},"description":"City names of the headquarters, e.g. [\"Austin\"]"},"limit":{"type":"integer","minimum":0,"maximum":25,"default":25,"description":"Maximum companies to return; 0 returns only a free count"},"offset":{"type":"integer","minimum":0,"maximum":10000,"default":0,"description":"Number of matching companies to skip for pagination"},"includeWithoutWebsite":{"type":"boolean","default":false,"description":"Include companies without websites in search results"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"number"},"chargedCredits":{"type":"number"},"organizations":{"type":"array","items":{"type":"object","properties":{"organizationId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"websiteAlive":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"websiteTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"websiteDescription":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedinDescription":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"industry":{"anyOf":[{"type":"string"},{"type":"null"}]},"naicsCodes":{"type":"array","items":{"type":"string"}},"keywords":{"anyOf":[{"type":"string"},{"type":"null"}]},"technologies":{"anyOf":[{"type":"string"},{"type":"null"}]},"employeeCount":{"anyOf":[{"type":"number"},{"type":"null"}]},"employeeMin":{"anyOf":[{"type":"number"},{"type":"null"}]},"employeeMax":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenueRange":{"anyOf":[{"type":"string"},{"type":"null"}]},"monthlyVisits":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Estimated monthly website visits"},"monthlyGoogleAdSpend":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Estimated monthly Google Ads spend in USD"},"employeeGrowthRate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Employee growth on LinkedIn in percent"},"lastFunding":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. Seed Round, Series A, Private Equity Round"},"date":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"USD"}},"required":["type","date","amount"]},"totalFunding":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"USD"},"foundedYear":{"anyOf":[{"type":"number"},{"type":"null"}]},"hqCity":{"anyOf":[{"type":"string"},{"type":"null"}]},"hqState":{"anyOf":[{"type":"string"},{"type":"null"}]},"hqCountry":{"anyOf":[{"type":"string"},{"type":"null"}]},"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","properties":{"facebook":{"anyOf":[{"type":"string"},{"type":"null"}]},"instagram":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}]},"x":{"anyOf":[{"type":"string"},{"type":"null"}]},"tiktok":{"anyOf":[{"type":"string"},{"type":"null"}]},"youtube":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["facebook","instagram","linkedin","x","tiktok","youtube"]},"adPixels":{"type":"object","properties":{"meta":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"googleAds":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"googleAnalytics":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"tiktok":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"chatgpt":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["meta","googleAds","googleAnalytics","tiktok","chatgpt"],"description":"true/false where the website was checked, null where it never was"}},"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"]}}},"required":["totalCount","chargedCredits","organizations"]}}}}}}},"/organizations/enrich":{"post":{"operationId":"organizations.enrich","summary":"Enrich a company from its domain","description":"Returns the company's firmographics, socials and website data. Charges 0.5 credits only when the company is found. Send an Idempotency-Key header to make retries safe.","tags":["Organizations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","minLength":3,"description":"Company domain or website URL, e.g. \"stripe.com\""}},"required":["domain"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"found":{"type":"boolean"},"chargedCredits":{"type":"number"},"organization":{"anyOf":[{"type":"object","properties":{"organizationId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"websiteAlive":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"websiteTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"websiteDescription":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedinDescription":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"industry":{"anyOf":[{"type":"string"},{"type":"null"}]},"naicsCodes":{"type":"array","items":{"type":"string"}},"keywords":{"anyOf":[{"type":"string"},{"type":"null"}]},"technologies":{"anyOf":[{"type":"string"},{"type":"null"}]},"employeeCount":{"anyOf":[{"type":"number"},{"type":"null"}]},"employeeMin":{"anyOf":[{"type":"number"},{"type":"null"}]},"employeeMax":{"anyOf":[{"type":"number"},{"type":"null"}]},"revenueRange":{"anyOf":[{"type":"string"},{"type":"null"}]},"monthlyVisits":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Estimated monthly website visits"},"monthlyGoogleAdSpend":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Estimated monthly Google Ads spend in USD"},"employeeGrowthRate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Employee growth on LinkedIn in percent"},"lastFunding":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"e.g. Seed Round, Series A, Private Equity Round"},"date":{"anyOf":[{"type":"string"},{"type":"null"}]},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"USD"}},"required":["type","date","amount"]},"totalFunding":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"USD"},"foundedYear":{"anyOf":[{"type":"number"},{"type":"null"}]},"hqCity":{"anyOf":[{"type":"string"},{"type":"null"}]},"hqState":{"anyOf":[{"type":"string"},{"type":"null"}]},"hqCountry":{"anyOf":[{"type":"string"},{"type":"null"}]},"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","properties":{"facebook":{"anyOf":[{"type":"string"},{"type":"null"}]},"instagram":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}]},"x":{"anyOf":[{"type":"string"},{"type":"null"}]},"tiktok":{"anyOf":[{"type":"string"},{"type":"null"}]},"youtube":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["facebook","instagram","linkedin","x","tiktok","youtube"]},"adPixels":{"type":"object","properties":{"meta":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"googleAds":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"googleAnalytics":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"tiktok":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"chatgpt":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["meta","googleAds","googleAnalytics","tiktok","chatgpt"],"description":"true/false where the website was checked, null where it never was"}},"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"]},{"type":"null"}]}},"required":["found","chargedCredits","organization"]}}}}}}},"/organizations/{organizationId}/decision-maker":{"post":{"operationId":"organizations.findDecisionMaker","summary":"Find the decision maker of an organization with a verified email","description":"Charges 2 credits only when a decision maker is found. Can take a few minutes. Send an Idempotency-Key header to make retries safe.","tags":["Organizations"],"parameters":[{"name":"organizationId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Company ID returned by organization search or enrichment"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"found":{"type":"boolean"},"creditsCharged":{"type":"number"},"decisionMaker":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"position":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin":{"type":"string"},"email":{"type":"string"}},"required":["name","position","linkedin","email"]},{"type":"null"}]}},"required":["found","creditsCharged","decisionMaker"]}}}}}}},"/persons/search":{"post":{"operationId":"persons.search","summary":"Search persons with their emails and phones","description":"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. Send an Idempotency-Key header to make retries safe.","tags":["Persons"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"description":"Free text matched against company name, description and keywords"},"semantic":{"type":"string","minLength":1,"description":"What the company is and sells, matched by meaning, e.g. \"outsourced medical billing for clinics\""},"domains":{"type":"array","maxItems":100,"items":{"type":"string"},"description":"Look companies up by domain, e.g. [\"stripe.com\"]"},"hqCountry":{"type":"array","items":{"type":"string"},"description":"ISO alpha-2 country codes of the headquarters, e.g. [\"US\", \"DE\"]"},"hqState":{"type":"array","items":{"type":"string"},"description":"US state names or codes of the headquarters"},"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"},"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"},"industryNaicsDirect":{"type":"array","items":{"type":"string"},"description":"NAICS codes"},"technologies":{"type":"array","items":{"type":"string"},"description":"Technologies used by the company"},"foundedAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Earliest founding year to include"},"foundedBefore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Latest founding year to include"},"monthlyVisitsMin":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Minimum monthly website visits; known for about 1 in 8 US companies, the rest are excluded"},"employeeGrowthMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum employee growth on LinkedIn in percent, e.g. 10; known for about 1 in 13 US companies"},"fundedAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Year of the last funding round, at least; known for about 1 in 100 US companies"},"jobTitle":{"type":"array","items":{"type":"string"},"description":"Matched as partial text, so \"CEO\" also finds \"Assistant to the CEO\"; combine with jobLevel to narrow"},"jobTitleExclude":{"type":"array","items":{"type":"string"},"description":"Job title phrases to exclude"},"jobLevel":{"type":"array","items":{"enum":["C-Team","VP","Director","Manager","Staff","Other"],"type":"string"},"description":"Allowed job seniority levels"},"decisionMakersOnly":{"type":"boolean","description":"C-level, VP or director seniority, or a founder, owner, CEO, managing director or president title"},"inCountry":{"type":"array","items":{"type":"string"},"description":"ISO alpha-2 country codes where the person is based"},"personState":{"type":"array","items":{"type":"string"},"description":"States where the person is based"},"personCity":{"type":"array","items":{"type":"string"},"description":"Cities where the person is based"},"organizationIds":{"type":"array","items":{"type":"string"},"description":"Limit to organizations from /organizations/search"},"limit":{"type":"integer","minimum":0,"maximum":100,"default":25,"description":"Maximum people to return; 0 returns only a free count"},"offset":{"type":"integer","minimum":0,"maximum":10000,"default":0,"description":"Pagination offset; use nextOffset from the previous response"},"onePerOrganization":{"type":"boolean","default":false,"description":"Return at most one person per company"},"saveToContacts":{"type":"boolean","default":false,"description":"Save returned people to your Deeplead contacts"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"number","description":"With limit 0: all matching people, including those without an email or phone"},"nextOffset":{"anyOf":[{"type":"number"},{"type":"null"}]},"chargedCredits":{"type":"number"},"persons":{"type":"array","items":{"type":"object","properties":{"personId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"alternateEmails":{"type":"array","items":{"type":"string"}},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phones":{"type":"array","items":{"type":"string"}},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobLevel":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobFunction":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyWebsite":{"anyOf":[{"type":"string"},{"type":"null"}]},"revenueRange":{"anyOf":[{"type":"string"},{"type":"null"}]},"naicsCodes":{"type":"array","items":{"type":"string"}},"foundedYear":{"anyOf":[{"type":"number"},{"type":"null"}]},"companyMonthlyVisits":{"anyOf":[{"type":"number"},{"type":"null"}]},"companyEmployeeGrowthRate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percent"},"companyLastFundingType":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyLastFundingDate":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["personId","name","email","alternateEmails","phone","phones","linkedin","jobTitle","jobLevel","jobFunction","city","state","country","organizationId","companyName","companyWebsite","revenueRange","naicsCodes","foundedYear","companyMonthlyVisits","companyEmployeeGrowthRate","companyLastFundingType","companyLastFundingDate"]}}},"required":["totalCount","nextOffset","chargedCredits","persons"]}}}}}}},"/persons/lookup":{"post":{"operationId":"persons.lookup","summary":"Look up one person by LinkedIn URL, email, or name and company domain","description":"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. Send an Idempotency-Key header to make retries safe.","tags":["Persons"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"linkedin":{"type":"string","minLength":1,"description":"e.g. \"https://www.linkedin.com/in/jane-doe\""},"email":{"type":"string","format":"email","description":"Known email address identifying the person"},"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\""},"saveToContacts":{"type":"boolean","default":false,"description":"Save the returned person to your Deeplead contacts"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"found":{"type":"boolean"},"chargedCredits":{"type":"number"},"person":{"anyOf":[{"type":"object","properties":{"personId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"alternateEmails":{"type":"array","items":{"type":"string"}},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phones":{"type":"array","items":{"type":"string"}},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobLevel":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobFunction":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyWebsite":{"anyOf":[{"type":"string"},{"type":"null"}]},"revenueRange":{"anyOf":[{"type":"string"},{"type":"null"}]},"naicsCodes":{"type":"array","items":{"type":"string"}},"foundedYear":{"anyOf":[{"type":"number"},{"type":"null"}]},"companyMonthlyVisits":{"anyOf":[{"type":"number"},{"type":"null"}]},"companyEmployeeGrowthRate":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Percent"},"companyLastFundingType":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyLastFundingDate":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["personId","name","email","alternateEmails","phone","phones","linkedin","jobTitle","jobLevel","jobFunction","city","state","country","organizationId","companyName","companyWebsite","revenueRange","naicsCodes","foundedYear","companyMonthlyVisits","companyEmployeeGrowthRate","companyLastFundingType","companyLastFundingDate"]},{"type":"null"}]}},"required":["found","chargedCredits","person"]}}}}}}},"/persons/email/find":{"post":{"operationId":"persons.findEmail","summary":"Find a person's work email by LinkedIn URL, or full name and company domain","description":"Charges 1 credit only when an email is found. Send an Idempotency-Key header to make retries safe.","tags":["Persons"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"linkedin":{"type":"string","minLength":1,"description":"e.g. \"https://www.linkedin.com/in/jane-doe\""},"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\""}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"found":{"type":"boolean"},"chargedCredits":{"type":"number"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"alternateEmails":{"type":"array","items":{"type":"string"}},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyWebsite":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["found","chargedCredits","email","alternateEmails","name","jobTitle","companyName","companyWebsite","linkedin"]}}}}}}},"/persons/phone/find":{"post":{"operationId":"persons.findPhone","summary":"Find a person's phone number by LinkedIn URL, email, or full name and company domain","description":"Covers professional contacts only: people in their role at a company, not private individuals. Charges 2 credits only when a phone number is found. Send an Idempotency-Key header to make retries safe.","tags":["Persons"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"linkedin":{"type":"string","minLength":1,"description":"e.g. \"https://www.linkedin.com/in/jane-doe\""},"email":{"type":"string","format":"email","description":"Known email address identifying the person"},"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\""}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"found":{"type":"boolean"},"chargedCredits":{"type":"number"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"phones":{"type":"array","items":{"type":"string"}},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyName":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyWebsite":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["found","chargedCredits","phone","phones","name","jobTitle","companyName","companyWebsite","linkedin"]}}}}}}},"/persons/save":{"post":{"operationId":"persons.save","summary":"Save matching persons to contacts (deprecated: use /persons/search with saveToContacts)","description":"Returns only people with an email or phone, so it can return fewer than count. Charges 1 credit per person newly saved; people already in your contacts are refunded. Send an Idempotency-Key header to make retries safe.","deprecated":true,"tags":["Persons"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"description":"Free text matched against company name, description and keywords"},"semantic":{"type":"string","minLength":1,"description":"What the company is and sells, matched by meaning, e.g. \"outsourced medical billing for clinics\""},"domains":{"type":"array","maxItems":100,"items":{"type":"string"},"description":"Look companies up by domain, e.g. [\"stripe.com\"]"},"hqCountry":{"type":"array","items":{"type":"string"},"description":"ISO alpha-2 country codes of the headquarters, e.g. [\"US\", \"DE\"]"},"hqState":{"type":"array","items":{"type":"string"},"description":"US state names or codes of the headquarters"},"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"},"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"},"industryNaicsDirect":{"type":"array","items":{"type":"string"},"description":"NAICS codes"},"technologies":{"type":"array","items":{"type":"string"},"description":"Technologies used by the company"},"foundedAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Earliest founding year to include"},"foundedBefore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Latest founding year to include"},"monthlyVisitsMin":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Minimum monthly website visits; known for about 1 in 8 US companies, the rest are excluded"},"employeeGrowthMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum employee growth on LinkedIn in percent, e.g. 10; known for about 1 in 13 US companies"},"fundedAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Year of the last funding round, at least; known for about 1 in 100 US companies"},"jobTitle":{"type":"array","items":{"type":"string"},"description":"Matched as partial text, so \"CEO\" also finds \"Assistant to the CEO\"; combine with jobLevel to narrow"},"jobTitleExclude":{"type":"array","items":{"type":"string"},"description":"Job title phrases to exclude"},"jobLevel":{"type":"ar

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deeplead/refs/heads/main/openapi/deeplead-api-openapi.json