Schemas
RevealSearchRequest
queryNatural language query - AI assistant will select appropriate filters for you. Note: Use this only on the first request, then use the filters parameter for subsequent requests
Structured search filters to narrow company results
pagePage number for pagination
webhook_urlOptional webhook URL to receive results asynchronously. If not provided, results will be returned in the response body.
RevealFilters
Filter by company name
Filter by country (ISO 3166-1 alpha-2 codes)
Filter by city name
Filter by state or province name
Filter by industry classification
Filter by company size range (e.g., 1-10, 11-50, 51-200)
Filter by company type (e.g., private, public)
Filter by keywords associated with companies
Filter by founding year or year range
Filter by technologies used by the company
Filter by similarity to a reference domain
Filter by estimated annual revenue range
Filter by Standard Industrial Classification (SIC) code
Filter by North American Industry Classification System (NAICS) code
SearchFilter
includeValues to include in the filter
excludeValues to exclude from the filter
PremiumSearchFilter
includeValues to include in the filter
excludeValues to exclude from the filter
RevealSearchResponse
successIndicates if the request was successful
Search results containing matched companies
Response metadata including pagination and applied filters
messageOptional message
RevealMeta
totalTotal number of companies found
pageCurrent page number
limitNumber of results per page
pagesTotal number of pages
Applied filters for the search
RevealData
Array of company results
totalTotal number of companies found
pageCurrent page number
limitNumber of results per page
pagesTotal number of pages
Company
nameCompany name
descriptionCompany description
countryCountry where the company is located
stateState/province where the company is located
cityCity where the company is located
street_addressStreet address of the company
postal_codePostal/ZIP code
industryIndustry sector
company_sizeNumber of employees
typeCompany type (e.g., Private, Public)
foundedYear the company was founded
website_urlCompany website URL
total_emailsTotal number of email addresses found for this company
revenueAnnual revenue range
phone_numberIndicates if a phone number is available
linkedin_urlLinkedIn company page URL
facebook_urlFacebook company page URL
twitter_urlTwitter company page URL
instagram_urlInstagram company page URL
github_urlGitHub company page URL
youtube_urlYouTube company page URL
pinterest_urlPinterest company page URL
tiktok_urlTikTok company page URL
total_similarNumber of similar companies found
DomainSearch
Domain search results containing organization info and email addresses
Pagination and query metadata
EmailSource
uriURL of the web page where the email was found
website_urlRoot domain of the source website
extracted_onDate when the email was first extracted from this source
last_seen_onDate when the email was last seen on this source
still_on_pageWhether the email is still present on the source page
FinderVerification
dateDate when the email was last verified
statusVerification result
PhoneData
validWhether the phone number is valid
local_formatPhone number in local format
intl_formatPhone number in international format
e164_formatPhone number in E.164 format
rfc3966_formatPhone number in RFC 3966 URI format
country_codeISO country code for the phone number
line_typePhone line type (mobile, landline, voip)
carrierTelecommunications carrier name
Geographic region of the phone number
timezonesTimezones associated with the phone number
EnrichmentPersonAPI
Person's name details
emailPrimary email address
locationGeographic location description
timeZoneIANA timezone identifier (e.g., America/New_York)
utcOffsetUTC offset in hours
Geographical coordinates and location details
bioShort biography or professional summary
sitePersonal website URL
avatarProfile image URL
Current employment information
Facebook profile information
GitHub profile information
Twitter/X profile information
LinkedIn profile information
Gravatar profile information
fuzzyWhether the result is a fuzzy (approximate) match
emailProviderWhether the email domain is an email service provider
indexedAtTimestamp when the person's data was last indexed
phonePhone number associated with the person
activeAtTimestamp when the person was last known to be active
inactiveAtTimestamp when the person was detected as inactive
EnrichmentCompanyAPI
idUnique company identifier
nameCompany name
legalNameRegistered legal name of the company
domainPrimary domain name of the company
domainAliasesAlternative domain names owned by the company
Company website information
Industry classification details
tagsDescriptive tags associated with the company
descriptionBrief description of the company and its activities
foundedYearYear the company was founded
locationHeadquarters location as a formatted string
timeZoneIANA timezone of the company's headquarters
utcOffsetUTC offset in hours for the headquarters location
Geographical coordinates and detailed address
logoURL to the company logo image
Facebook page information
LinkedIn company page information
Twitter/X account information
Crunchbase profile information
emailProviderWhether the company is an email service provider
typeCompany type (e.g., private, public, nonprofit, education)
tickerStock exchange ticker symbol
Business identification numbers
phoneCompany's primary phone number
Company size and traffic metrics
indexedAtTimestamp when the company data was last indexed
techTechnologies and tools used by the company
techCategoriesCategories of technologies used (e.g., analytics, cms, hosting)
Parent company information
Ultimate parent company in the corporate hierarchy
EnrichmentCombinedAPI
Person enrichment data matching the query
Company enrichment data for the person's employer
EmailSources
emailThe email address for which sources were retrieved
Array of web sources where the email was discovered
DomainTechnology
domainThe domain that was analyzed
Array of technologies detected on the domain
Lead
idUnique identifier for the lead
emailLead's email address
firstNameLead's first name
lastNameLead's last name
companyCompany the lead is associated with
titleLead's job title or position
Custom attributes assigned to this lead
LeadAttribute
idUnique identifier for the attribute
nameName of the custom attribute
valueValue of the custom attribute
LeadsList
idUnique identifier for the list
nameName of the lead list
descriptionDescription of the lead list
Array of leads belonging to this list
APIKey
idUnique identifier for the API key
keyThe API key value
createdAtTimestamp when the API key was created
Usage
requestsNumber of API requests made in the current period
limitMaximum number of requests allowed in the period
resetAtTimestamp when the usage counter resets
Log
idUnique identifier for the log entry
endpointAPI endpoint that was called
methodHTTP method used (GET, POST, PUT, DELETE)
statusHTTP response status code
timestampTimestamp when the request was made
APIErrorResponse
Error details for the failed request.
BulkDef
nameName of the bulk operation
listList of items to process (domains, emails, etc.)
sourcesInclude sources in results
notifieSend notifications
verifyEnable verification
totalTotal number of items
delimiterCSV delimiter character
validValid flag
columnColumn number for processing
BulkPostSearch
maximumMaximum results per domain
Type of emails to search for
Department filter
BulkPostFinder
column_firstFirst name column number
column_lastLast name column number
column_nameFull name column number
column_domainDomain column number (required)
skipSkip first row (header)
BulkItem
bulk_idUnique identifier for the bulk operation
nameName of the bulk operation
maximumMaximum results setting
email_typeEmail type filter
departmentDepartment filter
sourcesSources included
file_nameGenerated filename
totalTotal results
total_listTotal items in list
statusCompletion status
chartChart data
tableTable data
created_atCreation timestamp
user_idUser ID who created the bulk
launchedWhether the bulk has been launched
usedWhether results have been downloaded
time_trackTime tracking information
progressProgress percentage
verifyVerification enabled
verify_costVerification cost
total_emailsTotal emails found
processedNumber of items processed
expired_atExpiration timestamp
expiredWhether the bulk has expired
bulk_typeType of bulk operation
BulkProgress
statusCurrent status
progressProgress percentage
processedNumber of items processed
PaginationMeta
totalTotal number of items
pageSizeItems per page
currentCurrent page number
total_pagesTotal number of pages
DeleteResponse
statusOperation status
messageStatus message
codeHTTP status code
APIError
typeError type
messageError message
codeHTTP status code
DomainSuggestionsResponse
Array of suggested domain objects
DomainSuggestion
nameThe company or organization name associated with the domain
domain^[a-zA-Z0-9][a-zA-Z0… · requiredThe primary domain name of the suggested company
email_countThe number of email addresses available for this domain
SuggestionsMeta
queryThe original search query used to generate suggestions
limitThe maximum number of suggestions returned in this response
total_foundTotal number of suggestions found (may be more than returned due to limit)
country^[A-Z]{2}$Country filter applied to the search
industryIndustry filter applied to the search
min_emailsMinimum email count filter applied
processing_timeTime taken to process the request in milliseconds
LinkedinFinderData
emailEmail address found
phone_numberIndicates if a phone number is available
scoreConfidence score of the result
Email verification status
Sources where the email was found
website_urlCompany website URL
accept_allWhether the domain accepts all emails
first_nameFirst name of the person
last_nameLast name of the person
full_nameFull name of the person
countryCountry of the person
genderGender of the person
patternCommon email pattern used by the organization (e.g., {first}.{last})
departmentDepartment the person belongs to
typeEmail type: personal or generic
positionJob position/title
twitterTwitter handle
linkedinLinkedIn profile URL
disposableWhether the email is from a disposable domain
webmailWhether the email is from a webmail provider
companyCompany name
Phone numbers associated with this person (when enrich_mobile=true)
Author and article metadata extracted from content sources
LinkedinFinderSource
uriSource URI
website_urlWebsite URL of the source
extracted_onDate when the email was first extracted
last_seen_onDate when the email was last seen
still_on_pageWhether the email is still present on the page
LinkedinFinderVerification
dateDate of verification
statusVerification status
AuthorFinder
Author finder result data
AuthorInfo
urlURL of the article or page
titlePage or article title
og_imageOpen Graph image URL
descriptionPage or article description
article_domainDomain where the article was found
publisher_namePublisher name of the article source
publish_dateDate when the article was published
Author candidates extracted from the article
FlagCreateRequest
flag_typeType of data being flagged
valueThe flagged item (email address, domain, phone number, URL)
reasonReason for flagging. Valid reasons depend on flag_type: email(hard_bounce,invalid_email,wrong_person,outdated,other), organization(wrong_company,outdated,other), phone(wrong_phone,outdated,other), author_url(broken_url,wrong_person,outdated,other), website(broken_url,wrong_company,outdated,other)
commentOptional additional details about the issue
FlagItem
idUnique flag identifier
flag_typeType of data that was flagged
valueThe flagged item
reasonReason for flagging
commentAdditional details provided by the reporter
statusCurrent status of the flag
credits_refundedNumber of credits refunded (for confirmed hard bounces)
resolved_atWhen the flag was resolved by an admin
created_atWhen the flag was created