RevealSearchRequest
querystring · minLength: 8 · maxLength: 100Natural language query - AI assistant will select appropriate filters for you
Example: Real Estate in FrancefiltersobjectStructured filters for company search
pageinteger · min: 1 · max: 1000Page number for pagination
Default: 1limitinteger · min: 1 · max: 100Number of results per page
Default: 50
RevealFilters
companyobjectInclude/exclude filter options
location_countryobjectInclude/exclude filter options
location_cityobjectInclude/exclude filter options
location_stateobjectInclude/exclude filter options
industryobjectInclude/exclude filter options
sizeobjectInclude/exclude filter options
typeobjectInclude/exclude filter options
keywordsobjectInclude/exclude filter options
foundedobjectInclude/exclude filter options
technologiesobjectInclude/exclude filter options
similarobjectInclude/exclude filter options
revenueobjectInclude/exclude filter options
suggestionobjectInclude/exclude filter options
Filter
includestring[] · maxItems: 50Values to include in the filter
excludestring[] · maxItems: 50Values to exclude from the filter
RevealSearchResponse
successboolean · requiredIndicates if the request was successful
dataobject · required
messagestringOptional message
RevealData
companiesobject[] · requiredArray of company results
totalinteger · requiredTotal number of companies found
pageinteger · requiredCurrent page number
limitinteger · requiredNumber of results per page
pagesinteger · requiredTotal number of pages
Company
namestringCompany name
descriptionstringCompany description
countrystringCountry where the company is located
statestringState/province where the company is located
citystringCity where the company is located
street_addressstringStreet address of the company
postal_codestringPostal/ZIP code
industrystringIndustry sector
company_sizestringNumber of employees
Example: 101-500typestringCompany type (e.g., Private, Public)
Example: PrivatefoundedstringYear the company was founded
website_urlstring · uriCompany website URL
total_emailsintegerTotal number of email addresses found for this company
revenuestringAnnual revenue range
Example: $10M-$50Mphone_numberstringCompany phone number
linkedin_urlstring · uriLinkedIn company page URL
facebook_urlstring · uriFacebook company page URL
twitter_urlstring · uriTwitter company page URL
total_similarintegerNumber of similar companies found
EmailFinder
emailstringfirst_namestringlast_namestringfull_namestringcountrystring · nullablepositionstring · nullabletwitterstring · nullablelinkedinstring · nullablephone_numberstring · nullableaccept_allbooleanwebsite_urlstringcompanystringscoreinteger · int32verificationobjectsourcesobject[]
EnrichmentPersonAPI
nameobjectemailstringlocationstringtimeZonestringutcOffsetnumbergeoobjectbiostringsitestringavatarstringemploymentobjectfacebookobjectgithubobjecttwitterobjectlinkedinobjectgravatarobjectfuzzybooleanemailProviderbooleanindexedAtstringphonestringactiveAtstringinactiveAtstring
EnrichmentCompanyAPI
idstringnamestringlegalNamestringdomainstringdomainAliasesstring[]siteobjectcategoryobjecttagsstring[]descriptionstringfoundedYearnumberlocationstringtimeZonestringutcOffsetnumbergeoobjectlogostringfacebookobjectlinkedinobjecttwitterobjectcrunchbaseobjectemailProviderbooleantypestringtickeridentifiersobjectphonemetricsobjectindexedAtstringtechstring[]techCategoriesstring[]parentobjectultimateParentobject
Lead
idstring · requiredemailstring · required
firstNamestringlastNamestringcompanystringtitlestringattributesobject[]
Log
idstring · requiredendpointstring · requiredmethodstring · requiredstatusinteger · requiredtimestampstring · date-time · required
BulkDef
namestring · minLength: 3 · maxLength: 200 · requiredName of the bulk operation
liststringList of items to process (domains, emails, etc.)
sourcesbooleanInclude sources in results
notifiebooleanSend notifications
verifybooleanEnable verification
totalintegerTotal number of items
delimiterstringCSV delimiter character
validbooleanValid flag
columnintegerColumn number for processing
BulkPostSearch
maximumstring · enum · requiredMaximum results per domain
Enum values:15102050100email_typeobject · requiredType of emails to search for
departmentobject · requiredDepartment filter
BulkPostFinder
column_firstintegerFirst name column number
column_lastintegerLast name column number
column_nameintegerFull name column number
column_domainintegerDomain column number (required)
skipbooleanSkip first row (header)
BulkItem
bulk_idinteger · int64Unique identifier for the bulk operation
namestringName of the bulk operation
maximumstringMaximum results setting
email_typestringEmail type filter
departmentstringDepartment filter
sourcesbooleanSources included
file_namestringGenerated filename
totalintegerTotal results
total_listintegerTotal items in list
statusbooleanCompletion status
chartobjectChart data
tableobjectTable data
created_atstring · date-timeCreation timestamp
user_idinteger · int64User ID who created the bulk
launchedbooleanWhether the bulk has been launched
usedbooleanWhether results have been downloaded
time_trackstringTime tracking information
progressinteger · min: 0 · max: 100Progress percentage
verifybooleanVerification enabled
verify_costintegerVerification cost
total_emailsintegerTotal emails found
processedintegerNumber of items processed
expired_atstring · date-timeExpiration timestamp
expiredbooleanWhether the bulk has expired
bulk_typestringType of bulk operation
BulkProgress
statusbooleanCurrent status
progressinteger · min: 0 · max: 100Progress percentage
processedintegerNumber of items processed
PaginationMeta
totalintegerTotal number of items
pageSizeintegerItems per page
currentintegerCurrent page number
total_pagesnumberTotal number of pages
Error
typestring · enumError type
Enum values:params_invalidunknown_recordunknown_routequeuedrate_limitapi_errorip_blockedauthentication_failedmessagestringError message
codeintegerHTTP status code
DomainSuggestionsResponse
dataobject[] · requiredArray of suggested domain objects
metaobject · required
DomainSuggestion
namestring · minLength: 1 · maxLength: 255 · requiredThe company or organization name associated with the domain
Example: Zapierdomainstring · hostname · pattern:^[a-zA-Z0-9][a-zA-Z0…· requiredThe primary domain name of the suggested company
Example: zapier.comemail_countinteger · min: 0 · requiredThe number of email addresses available for this domain
Example: 455
SuggestionsMeta
querystring · requiredThe original search query used to generate suggestions
Example: zapier.comlimitinteger · min: 1 · max: 50 · requiredThe maximum number of suggestions returned in this response
Example: 5total_foundinteger · min: 0 · requiredTotal number of suggestions found (may be more than returned due to limit)
Example: 15
countrystring | null · pattern:^[A-Z]{2}$Country filter applied to the search
Example: USindustrystring | nullIndustry filter applied to the search
Example: technologymin_emailsinteger | null · min: 0Minimum email count filter applied
Example: 10processing_timenumber | null · float · min: 0Time taken to process the request in milliseconds
Example: 156.7