Tomba

Schemas

RevealSearchRequest

query

string · minLength: 8 · maxLength: 100

Natural 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

Example: Real Estate in France

object

Structured filters for company search

page

integer · min: 1 · max: 1000

Page number for pagination

Default: 1

RevealFilters

Structured filters for company search

object

Include/exclude filter options

location_country

circular

location_city

circular

location_state

circular

industry

circular

size

circular

type

circular

keywords

circular

founded

circular

technologies

circular

similar

circular

revenue

circular

sic

circular

naics

circular

Filter

Include/exclude filter options

include

string[] · maxItems: 50

Values to include in the filter

exclude

string[] · maxItems: 50

Values to exclude from the filter

RevealSearchResponse

success

boolean · required

Indicates if the request was successful

object · required

object

message

string

Optional message

RevealMeta

total

integer · required

Total number of companies found

page

integer · required

Current page number

limit

integer · required

Number of results per page

pages

integer · required

Total number of pages

object

Applied filters for the search

RevealData

object[] · required

Array of company results

total

integer · required

Total number of companies found

page

integer · required

Current page number

limit

integer · required

Number of results per page

pages

integer · required

Total number of pages

Company

name

string

Company name

description

string

Company description

country

string

Country where the company is located

state

string

State/province where the company is located

city

string

City where the company is located

street_address

string

Street address of the company

postal_code

string

Postal/ZIP code

industry

string

Industry sector

company_size

string

Number of employees

Example: 101-500

type

string

Company type (e.g., Private, Public)

Example: Private

founded

string

Year the company was founded

website_url

string · uri

Company website URL

total_emails

integer

Total number of email addresses found for this company

revenue

string

Annual revenue range

Example: $10M-$50M

phone_number

boolean

Indicates if a phone number is available

linkedin_url

string · uri

LinkedIn company page URL

facebook_url

string · uri

Facebook company page URL

twitter_url

string · uri

Twitter company page URL

total_similar

integer

Number of similar companies found

Account

object

DomainSearch

object · required

EmailFinder

object

EmailVerifier

object

EnrichmentPersonAPI

object

email

string

location

string

timeZone

string

utcOffset

number

object

bio

string

site

string

avatar

string

object

fuzzy

boolean

emailProvider

boolean

indexedAt

string

phone

string

activeAt

string

inactiveAt

string

EnrichmentCompanyAPI

id

string

name

string

legalName

string

domain

string

domainAliases

string[]

object

tags

string[]

description

string

foundedYear

number

location

string

timeZone

string

utcOffset

number

object

logo

string

object

emailProvider

boolean

type

string

ticker

object

phone

object

indexedAt

string

tech

string[]

techCategories

string[]

object

EnrichmentCombinedAPI

object

EmailCount

object

Location

object[]

EmailSources

email

string

object[]

Format

object[]

DomainSimilar

object[]

DomainTechnology

domain

string

object[]

PhoneFinder

Lead

id

string · required

email

string · required

firstName

string

lastName

string

company

string

title

string

object[]

LeadAttribute

id

string · required

name

string · required

value

string · required

LeadsList

id

string · required

name

string · required

description

string

object[]

Key

id

string · required

key

string · required

createdAt

string · date-time

Usage

requests

integer · required

limit

integer · required

resetAt

string · date-time · required

Log

id

string · required

endpoint

string · required

method

string · required

status

integer · required

timestamp

string · date-time · required

Success

object

Errors

object · required

BulkDef

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

BulkPutRename

name

string · minLength: 3 · maxLength: 200 · required

New name for the bulk operation

BulkPostSearch

maximum

string · enum · required

Maximum results per domain

Enum values:

100

object · required

Type of emails to search for

object · required

Department filter

BulkPostFinder

column_first

integer

First name column number

column_last

integer

Last name column number

column_name

integer

Full name column number

column_domain

integer

Domain column number (required)

skip

boolean

Skip first row (header)

BulkPhoneValidator

column_phone

integer

Phone number column

column_country

integer

Country column

BulkItem

bulk_id

integer · int64

Unique identifier for the bulk operation

name

string

Name of the bulk operation

maximum

string

Maximum results setting

email_type

string

Email type filter

department

string

Department filter

sources

boolean

Sources included

file_name

string

Generated filename

total

integer

Total results

total_list

integer

Total items in list

status

boolean

Completion status

chart

object

Chart data

table

object

Table data

created_at

string · date-time

Creation timestamp

user_id

integer · int64

User ID who created the bulk

launched

boolean

Whether the bulk has been launched

used

boolean

Whether results have been downloaded

time_track

string

Time tracking information

progress

integer · min: 0 · max: 100

Progress percentage

verify

boolean

Verification enabled

verify_cost

integer

Verification cost

total_emails

integer

Total emails found

processed

integer

Number of items processed

expired_at

string · date-time

Expiration timestamp

expired

boolean

Whether the bulk has expired

bulk_type

string

Type of bulk operation

BulkProgress

status

boolean

Current status

progress

integer · min: 0 · max: 100

Progress percentage

processed

integer

Number of items processed

PaginationMeta

total

integer

Total number of items

pageSize

integer

Items per page

current

integer

Current page number

total_pages

number

Total number of pages

DataID

id

integer · int64

Created resource ID

Data

status

boolean

Operation status

message

string

Status message

code

integer

HTTP status code

Error

type

string · enum

Error type

Enum values:

params_invalid

unknown_record

unknown_route

queued

rate_limit

api_error

ip_blocked

authentication_failed

message

string

Error message

code

integer

HTTP status code

DomainSuggestionsResponse

object[] · required

Array of suggested domain objects

object · required

DomainSuggestion

name

string · minLength: 1 · maxLength: 255 · required

The company or organization name associated with the domain

Example: Zapier

domain

string · hostname · pattern: ^[a-zA-Z0-9][a-zA-Z0… · required

The primary domain name of the suggested company

Example: zapier.com

email_count

integer · min: 0 · required

The number of email addresses available for this domain

Example: 455

SuggestionsMeta

query

string · required

The original search query used to generate suggestions

Example: zapier.com

limit

integer · min: 1 · max: 50 · required

The maximum number of suggestions returned in this response

Example: 5

total_found

integer · min: 0 · required

Total number of suggestions found (may be more than returned due to limit)

Example: 15

country

string | null · pattern: ^[A-Z]{2}$

Country filter applied to the search

Example: US

industry

string | null

Industry filter applied to the search

Example: technology

min_emails

integer | null · min: 0

Minimum email count filter applied

Example: 10

processing_time

number | null · float · min: 0

Time taken to process the request in milliseconds

Example: 156.7

RevealSearchRequest

query

string · minLength: 8 · maxLength: 100

Natural 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

Example: Real Estate in France

object

Structured filters for company search

page

integer · min: 1 · max: 1000

Page number for pagination

Default: 1

Company

name

string

Company name

description

string

Company description

country

string

Country where the company is located

state

string

State/province where the company is located

city

string

City where the company is located

street_address

string

Street address of the company

postal_code

string

Postal/ZIP code

industry

string

Industry sector

company_size

string

Number of employees

Example: 101-500

type

string

Company type (e.g., Private, Public)

Example: Private

founded

string

Year the company was founded

website_url

string · uri

Company website URL

total_emails

integer

Total number of email addresses found for this company

revenue

string

Annual revenue range

Example: $10M-$50M

phone_number

boolean

Indicates if a phone number is available

linkedin_url

string · uri

LinkedIn company page URL

facebook_url

string · uri

Facebook company page URL

twitter_url

string · uri

Twitter company page URL

total_similar

integer

Number of similar companies found

EnrichmentCompanyAPI

id

string

name

string

legalName

string

domain

string

domainAliases

string[]

object

tags

string[]

description

string

foundedYear

number

location

string

timeZone

string

utcOffset

number

object

logo

string

object

emailProvider

boolean

type

string

ticker

object

phone

object

indexedAt

string

tech

string[]

techCategories

string[]

object

BulkDef

name

string · minLength: 3 · maxLength: 200 · required

Name of the bulk operation

list

string

List of items to process (domains, emails, etc.)

sources

boolean

Include sources in results

notifie

boolean

Send notifications

verify

boolean

Enable verification

total

integer

Total number of items

delimiter

string

CSV delimiter character

valid

boolean

Valid flag

column

integer

Column number for processing

BulkItem

bulk_id

integer · int64

Unique identifier for the bulk operation

name

string

Name of the bulk operation

maximum

string

Maximum results setting

email_type

string

Email type filter

department

string

Department filter

sources

boolean

Sources included

file_name

string

Generated filename

total

integer

Total results

total_list

integer

Total items in list

status

boolean

Completion status

chart

object

Chart data

table

object

Table data

created_at

string · date-time

Creation timestamp

user_id

integer · int64

User ID who created the bulk

launched

boolean

Whether the bulk has been launched

used

boolean

Whether results have been downloaded

time_track

string

Time tracking information

progress

integer · min: 0 · max: 100

Progress percentage

verify

boolean

Verification enabled

verify_cost

integer

Verification cost

total_emails

integer

Total emails found

processed

integer

Number of items processed

expired_at

string · date-time

Expiration timestamp

expired

boolean

Whether the bulk has expired

bulk_type

string

Type of bulk operation

DomainSuggestion

name

string · minLength: 1 · maxLength: 255 · required

The company or organization name associated with the domain

Example: Zapier

domain

string · hostname · pattern: ^[a-zA-Z0-9][a-zA-Z0… · required

The primary domain name of the suggested company

Example: zapier.com

email_count

integer · min: 0 · required

The number of email addresses available for this domain

Example: 455

SuggestionsMeta

query

string · required

The original search query used to generate suggestions

Example: zapier.com

limit

integer · min: 1 · max: 50 · required

The maximum number of suggestions returned in this response

Example: 5

total_found

integer · min: 0 · required

Total number of suggestions found (may be more than returned due to limit)

Example: 15

country

string | null · pattern: ^[A-Z]{2}$

Country filter applied to the search

Example: US

industry

string | null

Industry filter applied to the search

Example: technology

min_emails

integer | null · min: 0

Minimum email count filter applied

Example: 10

processing_time

number | null · float · min: 0

Time taken to process the request in milliseconds

Example: 156.7