Schemas
Account
data
object
DomainSearch
organization
objectemails
object[]
EmailFinder
email
stringfirst_name
stringlast_name
stringfull_name
stringcountry
string · nullableposition
string · nullabletwitter
string · nullablelinkedin
string · nullablephone_number
string · nullableaccept_all
booleanwebsite_url
stringcompany
stringscore
integer · int32verification
objectsources
object[]
EmailVerifier
email
objectsources
object[]
EnrichmentPersonAPI
name
objectemail
stringlocation
stringtimeZone
stringutcOffset
numbergeo
objectbio
stringsite
stringavatar
stringemployment
objectfacebook
objectgithub
objecttwitter
objectlinkedin
objectgravatar
objectfuzzy
booleanemailProvider
booleanindexedAt
stringphone
stringactiveAt
stringinactiveAt
string
EnrichmentCompanyAPI
id
stringname
stringlegalName
stringdomain
stringdomainAliases
string[]site
objectcategory
objecttags
string[]description
stringfoundedYear
numberlocation
stringtimeZone
stringutcOffset
numbergeo
objectlogo
stringfacebook
objectlinkedin
objecttwitter
objectcrunchbase
objectemailProvider
booleantype
stringticker
identifiers
objectphone
metrics
objectindexedAt
stringtech
string[]techCategories
string[]parent
objectultimateParent
object
EnrichmentCombinedAPI
person
objectcompany
object
EmailCount
data
object
Location
data
object[]
EmailSources
email
stringdata
object[]
Format
data
object[]
DomainSimilar
data
object[]
DomainTechnology
domain
stringdata
object[]
PhoneFinder
data
object
Lead
id
string · requiredemail
string · required
firstName
stringlastName
stringcompany
stringtitle
stringattributes
object[]
LeadAttribute
id
string · requiredname
string · requiredvalue
string · required
LeadsList
id
string · requiredname
string · required
description
stringleads
object[]
Key
id
string · requiredkey
string · required
createdAt
string · date-time
Usage
requests
integer · requiredlimit
integer · requiredresetAt
string · date-time · required
Log
id
string · requiredendpoint
string · requiredmethod
string · requiredstatus
integer · requiredtimestamp
string · date-time · required
Success
data
object
Errors
errors
object · required
BulkDef
name
string · minLength: 3 · maxLength: 200 · requiredName of the bulk operation
list
stringList of items to process (domains, emails, etc.)
sources
booleanInclude sources in results
notifie
booleanSend notifications
verify
booleanEnable verification
total
integerTotal number of items
delimiter
stringCSV delimiter character
valid
booleanValid flag
column
integerColumn number for processing
BulkPutRename
name
string · minLength: 3 · maxLength: 200 · requiredNew name for the bulk operation
BulkPostSearch
maximum
string · enum · requiredMaximum results per domain
Enum values:15102050100email_type
string · requiredType of emails to search for
department
string · requiredDepartment filter
BulkPostFinder
column_first
integerFirst name column number
column_last
integerLast name column number
column_name
integerFull name column number
column_domain
integerDomain column number (required)
skip
booleanSkip first row (header)
BulkPhoneValidator
column_phone
integerPhone number column
column_country
integerCountry column
BulkItem
bulk_id
integer · int64Unique identifier for the bulk operation
name
stringName of the bulk operation
maximum
stringMaximum results setting
email_type
stringEmail type filter
department
stringDepartment filter
sources
booleanSources included
file_name
stringGenerated filename
total
integerTotal results
total_list
integerTotal items in list
status
booleanCompletion status
chart
objectChart data
table
objectTable data
created_at
string · date-timeCreation timestamp
user_id
integer · int64User ID who created the bulk
launched
booleanWhether the bulk has been launched
used
booleanWhether results have been downloaded
time_track
stringTime tracking information
progress
integer · max: 100Progress percentage
verify
booleanVerification enabled
verify_cost
integerVerification cost
total_emails
integerTotal emails found
processed
integerNumber of items processed
expired_at
string · date-timeExpiration timestamp
expired
booleanWhether the bulk has expired
bulk_type
stringType of bulk operation
BulkProgress
status
booleanCurrent status
progress
integer · max: 100Progress percentage
processed
integerNumber of items processed
PaginationMeta
total
integerTotal number of items
pageSize
integerItems per page
current
integerCurrent page number
total_pages
numberTotal number of pages
DataID
id
integer · int64Created resource ID
Data
status
booleanOperation status
message
stringStatus message
code
integerHTTP status code
Error
type
string · enumError type
Enum values:params_invalidunknown_recordunknown_routequeuedrate_limitapi_errorip_blockedauthentication_failedmessage
stringError message
code
integerHTTP status code