• Documentation
Person
    Social URL to Person (1 credit per request)postGet Person by ID (1 credit per request)postName and Domain to Email (1 credit per request)post
Company
    LinkedIn URL to Company (1 credit per request)postDomain to Company (1 credit per request)postLinkedIn ID to Company (1 credit per request)postGet Company by ID (1 credit per request)post
Validation
    Validate an email address (1 credit)postValidate a phone number (1 credit)post
Search
    Search companiespostProspector searchpostProspector countpostFind a contact by name and company domainpostSearch by job title and company namepostSearch employees at a companypostSearch companies by name (exact or fuzzy)postSearch with AI (free-form text query)post
Field Meta
    Browse City valuespostBrowse Country Code valuespostBrowse Country Name valuespostBrowse Job Title valuespostBrowse State / Province valuespostBrowse Job Function valuespostBrowse Job Level valuespostBrowse Persona valuespostBrowse Company Entity Type valuespostBrowse Company Legal Type valuespostBrowse Industry (LinkedIn) valuespostBrowse CRM Technologies valuespostBrowse Marketing Automation Technologies valuespostBrowse ABM Technologies valuespostBrowse Sales Automation Technologies valuespostBrowse Analytics Technologies valuespostBrowse CMS Technologies valuespostBrowse MarTech Categories valuespostBrowse Conversation Intelligence Technologies valuespostBrowse Cloud Provider Technologies valuespostBrowse Email Hosting Technologies valuespostBrowse Email Security Technologies valuespostBrowse Application Security Technologies valuespostBrowse Cloud Security Technologies valuespostBrowse Development Technologies valuespostBrowse E-commerce Technologies valuespostBrowse ERP Technologies valuespost
User
    Get Credit Balanceget
Schemas
powered by Zudoku
B2BEnrich API
B2BEnrich API

Schemas


AISearchRequest

Search using natural language. Describe the contacts or companies you're looking for in plain English. The system interprets your query and returns matching results.
query
string · minLength: 3 · maxLength: 2000 · required

Your search query in plain English.

Example: Find software engineers at Google in San Francisco
page
integer · min: 1

Page number (1-based).

Default: 1
page_size
integer · min: 1 · max: 100

Records per page.

Default: 25

AISearchResponse

Response from the AI-powered search endpoint.
total_count
integer · required

Total matching records.

object

The equivalent Prospector API search object. You can submit this directly to /v1/search/prospector to reproduce the same search.

object[]

Matching rows.

page
integer

Current page number.

Default: 1
page_size
integer

Records per page.

Default: 25
has_more
boolean

Whether more pages are available.

Default: false

Next page number, or null.

AbstractEmailValidationResponse

Full response from the email validation endpoint.
Additional properties are allowed

AbstractPhoneValidationResponse

Full response from the phone intelligence endpoint.
Additional properties are allowed

BreachedDomain

Additional properties are allowed

Company

Data model representing a company's profile.

Internal company record ID

Company name

Company website domain

Company LinkedIn profile URL

Company LinkedIn URL ID (internal identifier)

Company overview and classification details

Website traffic analytics

Funding and investment details

Company headquarters location

Technology stack used by the company

CompanyAbout

Company's legal or trading name

Short description or 'about us' blurb

Industry classification (LinkedIn taxonomy)

Entity type (e.g. 'Public', 'Private')

Legal structure (e.g. 'Corporation', 'LLC')

Standard Industrial Classification (SIC) code

Estimated annual revenue range

Estimated employee count range

CompanyAnalytics

Estimated monthly organic website visits

Estimated monthly paid website visits

Estimated total monthly website visits

CompanyEmployeesRequest

Look up employees at a company. Provide at least one company identifier (id, linkedin_url, or domain). Optionally filter employees by name, title, function, level, or persona.

Organization ID.

Company LinkedIn URL (e.g. 'https://www.linkedin.com/company/google').

Company website domain (e.g. 'google.com').

First name(s). Single value or array for OR match.

Last name(s). Single value or array for OR match.

Job title(s). Single value or array for OR match.

Job function (e.g., 'Engineering', 'Sales'). Single value or array for OR match.

Job level (e.g., 'Director', 'VP'). Single value or array for OR match.

Persona classification. Single value or array for OR match.

City (e.g. 'San Francisco'). Single value or array for OR match.

State or province name (e.g. 'California'). Single value or array for OR match.

Country name (e.g. 'United States'). Single value or array for OR match.

page
integer · min: 1

Page number (1-indexed).

Default: 1
page_size
integer · min: 1 · max: 25

Results per page.

Default: 25

CompanyEmployeesResponse

object[] · required

Employees at the matched company.

total_count
integer · required

Total matching employees.

page
integer · required

Current page (1-indexed).

page_size
integer · required

Records per page.

has_more
boolean · required

True if more pages exist.

Next page number, or null.

CompanyFilters

Company search filters. All fields are optional. Supply a single value or an array for any filter. Multiple values within a field are OR-matched; different fields are ANDed.

Company name(s). Single value or array for OR match.

Company domain(s) (e.g., 'google.com'). Single value or array for OR match.

Company specialties / keywords. Single value or array for OR match.

LinkedIn industry classification. Single value or array for OR match.

SIC industry code(s). Single value or array for OR match.

Headquarters city/cities. Single value or array for OR match.

Headquarters state/province(s). Single value or array for OR match.

Headquarters country name(s). Single value or array for OR match.

Headquarters country ISO code(s) (e.g., 'US'). Single value or array for OR match.

Headquarters region (e.g., 'North America'). Single value or array for OR match.

Headquarters continent. Single value or array for OR match.

Company entity type (e.g., 'Public', 'Private'). Single value or array for OR match.

Company legal type (e.g., 'LLC', 'Corporation'). Single value or array for OR match.

Minimum employee count. Single value or array for OR match.

Maximum employee count. Single value or array for OR match.

Employee count range (e.g., '51-200'). Single value or array for OR match.

Number of employee profiles on LinkedIn. Single value or array for OR match.

Minimum revenue. Single value or array for OR match.

Maximum revenue. Single value or array for OR match.

Revenue range bracket. Single value or array for OR match.

Year founded. Single value or array for OR match.

Company LinkedIn URL(s). Single value or array for OR match.

CRM technology (e.g., 'Salesforce', 'HubSpot').

Marketing automation technology (e.g., 'Marketo').

ABM (Account-Based Marketing) technology.

Sales automation technology (e.g., 'Outreach').

Analytics technology (e.g., 'Google Analytics').

CMS technology (e.g., 'WordPress').

MarTech categories.

Conversation intelligence technology (e.g., 'Gong').

Cloud provider technology (e.g., 'AWS', 'Azure').

Email hosting technology (e.g., 'Google Workspace').

Email security technology.

Application security technology.

Cloud security technology.

Development technologies / languages.

E-commerce platform technology (e.g., 'Shopify').

ERP technology (e.g., 'SAP', 'Oracle').

Lead investor name(s).

Last funding round amount.

Total funding raised.

Marketing team headcount.

Sales team headcount.

Operations team headcount.

Business development team headcount.

Customer success team headcount.

IT team headcount.

Engineering team headcount.

Monthly organic website traffic.

Monthly paid website traffic.

Total monthly website traffic.

Monthly Google Ads spend.

Employee growth rate on LinkedIn.

CompanyFunding

Date of the most recent funding round

Amount raised in the most recent funding round (USD)

Type of the most recent funding round (e.g. 'Series A', 'Seed')

Number of investors in the most recent round

Total funding raised across all rounds (USD)

CompanyLocation

Company headquarters city

Company headquarters state or province

Company headquarters country

CompanyModel

Data model representing a company's profile.

CompanyNameSearchRecord

object · required

Company data

CompanyNameSearchRequest

Search for organizations by company name.
company_name
string · required

Company name to search for.

match_type
string · enum

Match mode. 'exact' — case-sensitive exact match. 'fuzzy' — case-insensitive substring match (ILIKE %%query%%).

Enum values:
exact
fuzzy
Default: exact
page
integer · min: 1

Page number (1-indexed).

Default: 1
page_size
integer · min: 1 · max: 25

Results per page.

Default: 25

CompanyNameSearchResponse

object[]
total_count
integer

Total matching records.

Default: 0
page
integer

Current page (1-indexed).

Default: 1
page_size
integer

Records per page.

Default: 25
has_more
boolean

True if more pages exist.

Default: false

Next page number, or null.

CompanyResponse

Response payload for company enrichment.
status
string

Status of the request

Default: success

Company record ID

Company data, null if not found

CompanySearchRequest

Search for companies using any combination of filters. All fields are optional. Supply a single value or an array for any filter. Multiple values within a field are OR-matched; different fields are ANDed.

Company name(s). Single value or array for OR match.

Website domain(s) (e.g. 'google.com'). Single value or array for OR match.

Company specialties / keywords. Single value or array for OR match.

LinkedIn industry classification. Single value or array for OR match.

SIC industry code(s). Single value or array for OR match.

Headquarters city/cities. Single value or array for OR match.

Headquarters state/province(s). Single value or array for OR match.

Headquarters country name(s). Single value or array for OR match.

Headquarters country ISO code(s) (e.g. 'US'). Single value or array for OR match.

Headquarters region (e.g. 'North America'). Single value or array for OR match.

Headquarters continent. Single value or array for OR match.

Company entity type (e.g. 'Public', 'Private'). Single value or array for OR match.

Company legal type (e.g. 'LLC', 'Corporation'). Single value or array for OR match.

Employee count range (e.g. '51-200'). Single value or array for OR match.

Revenue range bracket. Single value or array for OR match.

Year founded. Single value or array for OR match.

CRM technology (e.g., 'Salesforce', 'HubSpot').

Marketing automation technology (e.g., 'Marketo').

ABM (Account-Based Marketing) technology.

Sales automation technology (e.g., 'Outreach').

Analytics technology (e.g., 'Google Analytics').

CMS technology (e.g., 'WordPress').

MarTech categories.

Conversation intelligence technology (e.g., 'Gong').

Cloud provider technology (e.g., 'AWS', 'Azure').

Email hosting technology (e.g., 'Google Workspace').

Email security technology.

Application security technology.

Cloud security technology.

Development technologies / languages.

E-commerce platform technology (e.g., 'Shopify').

ERP technology (e.g., 'SAP', 'Oracle').

Lead investor name(s).

Last funding round amount.

Total funding raised.

Marketing team headcount.

Sales team headcount.

Operations team headcount.

Business development team headcount.

Customer success team headcount.

IT team headcount.

Engineering team headcount.

Monthly organic website traffic.

Monthly paid website traffic.

Total monthly website traffic.

Monthly Google Ads spend.

Employee growth rate on LinkedIn.

page
integer · min: 1

Page number (1-indexed).

Default: 1
page_size
integer · min: 1 · max: 25

Results per page.

Default: 25

CompanySearchResponse

object[] · required

Matching company records.

total_count
integer · required

Total matching records.

page
integer · required

Current page (1-indexed).

page_size
integer · required

Records per page.

has_more
boolean · required

True if more pages exist.

Next page number, or null.

CompanyTechnoligies

List of technologies used by the company (CRM, marketing, analytics, etc.)

ContactFilters

Contact search filters. All fields are optional. Supply a single value or an array for any filter. Multiple values within a field are OR-matched; different fields are ANDed.

About-me / bio text. Single value or array for OR match.

First name(s). Single value or array for OR match.

Full name(s). Single value or array for OR match.

Last name(s). Single value or array for OR match.

LinkedIn headline text. Single value or array for OR match.

Job title(s). Single value or array for OR match.

Job description text. Single value or array for OR match.

Skills keywords. Single value or array for OR match.

Interests keywords. Single value or array for OR match.

Education (school name, degree, etc.). Single value or array for OR match.

Certifications held. Single value or array for OR match.

Job function (e.g., 'Engineering', 'Sales'). Single value or array for OR match.

Job level (e.g., 'Director', 'VP'). Single value or array for OR match.

Persona classification. Single value or array for OR match.

City/cities of the contact. Single value or array for OR match.

State/province name(s). Single value or array for OR match.

Country name(s). Single value or array for OR match.

ISO country code(s) (e.g., 'US'). Single value or array for OR match.

LinkedIn industry classification. Single value or array for OR match.

Email domain(s) (e.g., 'google.com'). Single value or array for OR match.

Email status (e.g., 'verified', 'invalid'). Single value or array for OR match.

Job location city. Single value or array for OR match.

Job location country. Single value or array for OR match.

Whether the job is current ('true'/'false'). Single value or array.

Job start date. Single value or array for OR match.

Job end date. Single value or array for OR match.

Number of jobs held. Single value or array for OR match.

LinkedIn connection count. Single value or array for OR match.

EmailBreaches

Additional properties are allowed

EmailDeliverability

Additional properties are allowed

EmailDomain

Additional properties are allowed

EmailQuality

Additional properties are allowed

EmailRisk

Additional properties are allowed

EmailSender

Additional properties are allowed

EmailValidationRequest

Request body for email validation.
email
string · minLength: 1 · required

The email address to validate.

Example: john.doe@gmail.com

EmailValidationResponse

Wrapper returned by the ``/v1/validate/email`` endpoint.
status
string · required

'success' or 'error'.

Full email reputation payload, or null on failure.

ErrorResponse

Standard error payload for AppError exceptions.
detail
string · required
code
string
Default: error

FieldMetaRequest

Request for browsing distinct values of a field.

Optional search text to filter values (phrase search).

page
integer · min: 1

Page number (1-indexed). Each page returns up to 100 values.

Default: 1

FieldMetaResponse

Paginated list of distinct values for a field.
field
string · required

The field that was queried.

page
integer · required

Current page number.

has_more
boolean · required

True if more pages exist.

object[]

Distinct values.

page_size
integer

Maximum values per page.

Default: 100

FieldMetaValue

A single distinct value.
value
string · required

The distinct field value.

FirstLastDomainRequest

Search by first name, last name, and company domain.
first_name
string · required

Contact first name.

last_name
string · required

Contact last name.

domain
string · required

Company domain (e.g. 'google.com').

page
integer · min: 1

Page number (1-indexed).

Default: 1
page_size
integer · min: 1 · max: 25

Results per page.

Default: 25

FirstLastDomainResponse

object[] · required

Matching person records.

total_count
integer · required

Total matching records.

page
integer · required

Current page (1-indexed).

page_size
integer · required

Records per page.

has_more
boolean · required

True if more pages exist.

Next page number, or null.

HTTPValidationError

object[]

IdInputModel

Input model for ID-based enrichment requests.
id
integer · required

Internal record ID

LinkedinIdInputModel

Input model for LinkedIn numeric ID-based enrichment requests.
linkedin_id
integer · required

LinkedIn numeric company ID (linkedin_url_id)

PersonCurrentTitles

PersonEnrichmentResponse

Response payload for person enrichment.

Person record ID

status
string

Status of the request

Default: success

Person profile data, null if not found

PersonModel

Data model representing a person's profile.

Person's full name

Person's first name

Person's last name

Person's LinkedIn profile URL

Person's profile picture URL

Company website domain

Company LinkedIn industry

Company employee count range

Company revenue range

Person's city

Person's state code (e.g. 'CA')

Person's state name (e.g. 'California')

Person's country code (e.g. 'US')

Person's country name (e.g. 'United States')

Person's country region (e.g. 'APAC', 'EMEA')

PhoneBreachedDomain

Additional properties are allowed

PhoneBreaches

Additional properties are allowed

PhoneCarrier

Additional properties are allowed

PhoneFormat

Additional properties are allowed

PhoneLocation

Additional properties are allowed

PhoneMessaging

Additional properties are allowed

PhoneRegistration

Additional properties are allowed

PhoneRisk

Additional properties are allowed

PhoneValidation

Additional properties are allowed

PhoneValidationRequest

Request body for phone validation.
phone
string · minLength: 1 · required

The phone number to validate.

Example: +14159929960

Optional ISO country code (e.g. 'US') to help resolve national-format numbers.

Example: US

PhoneValidationResponse

Wrapper returned by the ``/v1/validate/phone`` endpoint.
status
string · required

'success' or 'error'.

Full phone intelligence payload, or null on failure.

ProspectorCountRequest

Same filters as ProspectorSearchRequest but returns only the total count. No pagination — the endpoint counts all matching rows.

Free-text search across contact fields (name, title, skills, etc.).

Filter by contact attributes (name, title, location, etc.).

Filter by company attributes (name, industry, size, tech stack, funding, traffic, etc.).

ProspectorCountResponse

total_count
integer · required

Total matching records.

ProspectorSearchRequest

Search across contacts, companies, and technology insights. Supply any combination of filter groups — contact filters, company filters, and/or insights filters. Only relevant data is queried based on which filters you provide. Fields within each group are ANDed.

Free-text search across contact fields (name, title, skills, etc.).

Filter by contact attributes (name, title, location, etc.).

Filter by company attributes (name, industry, size, tech stack, funding, traffic, etc.).

page
integer · min: 1

Page number (1-indexed).

Default: 1
page_size
integer · min: 1 · max: 50

Results per page (max 25; admin keys may use up to 50).

Default: 25

ProspectorSearchResponse

object[] · required

Matching rows.

total_count
integer · required

Total matching records.

page
integer · required

Current page (1-indexed).

page_size
integer · required

Records per page.

has_more
boolean · required

True if more pages exist.

Next page number, or null.

RequestInputModel

Input model for enrichment requests.
first_name
string · required

First name of the person

last_name
string · required

Last name of the person

domain
string · required

Domain of the person's email address

RequestResponse

Response payload containing verified email address.
status
string

Status of the request

Default: success

Verified email address

TitleCompanyRequest

Search by job title and/or company name.

Job title to search for.

Company name to search for.

page
integer · min: 1

Page number (1-indexed).

Default: 1
page_size
integer · min: 1 · max: 25

Results per page.

Default: 25

TitleCompanyResponse

object[] · required

Matching rows.

total_count
integer · required

Total matching records.

page
integer · required

Current page (1-indexed).

page_size
integer · required

Records per page.

has_more
boolean · required

True if more pages exist.

Next page number, or null.

ValidationError

array · required
msg
string · required
type
string · required

app__src__enrichment__companies__models__common__RequestInputModel

Input model for enrichment requests.
input
string · required

Input value for lookup (LinkedIn URL, email, phone, or domain)

app__src__enrichment__person__models__common__RequestInputModel

Input model for enrichment requests.
input
string · required

Input value for lookup (LinkedIn URL, email, phone, or domain)

app__src__enrichment__person__models__person_model__PersonModel

Data model representing a person's profile.

Person's full name

Person's first name

Person's last name

Person's LinkedIn profile URL

List of person's current job titles and companies

Person's city

Person's state code (e.g. 'CA')

Person's state name (e.g. 'California')

Person's country code (e.g. 'US')

Person's country name (e.g. 'United States')

Person's country region (e.g. 'APAC', 'EMEA')

Person's email address

List of person's phone numbers

On this page
  • AISearchRequest
  • AISearchResponse
  • AbstractEmailValidationResponse
  • AbstractPhoneValidationResponse
  • BreachedDomain
  • Company
  • CompanyAbout
  • CompanyAnalytics
  • CompanyEmployeesRequest
  • CompanyEmployeesResponse
  • CompanyFilters
  • CompanyFunding
  • CompanyLocation
  • CompanyModel
  • CompanyNameSearchRecord
  • CompanyNameSearchRequest
  • CompanyNameSearchResponse
  • CompanyResponse
  • CompanySearchRequest
  • CompanySearchResponse
  • CompanyTechnoligies
  • ContactFilters
  • EmailBreaches
  • EmailDeliverability
  • EmailDomain
  • EmailQuality
  • EmailRisk
  • EmailSender
  • EmailValidationRequest
  • EmailValidationResponse
  • ErrorResponse
  • FieldMetaRequest
  • FieldMetaResponse
  • FieldMetaValue
  • FirstLastDomainRequest
  • FirstLastDomainResponse
  • HTTPValidationError
  • IdInputModel
  • LinkedinIdInputModel
  • PersonCurrentTitles
  • PersonEnrichmentResponse
  • PersonModel
  • PhoneBreachedDomain
  • PhoneBreaches
  • PhoneCarrier
  • PhoneFormat
  • PhoneLocation
  • PhoneMessaging
  • PhoneRegistration
  • PhoneRisk
  • PhoneValidation
  • PhoneValidationRequest
  • PhoneValidationResponse
  • ProspectorCountRequest
  • ProspectorCountResponse
  • ProspectorSearchRequest
  • ProspectorSearchResponse
  • RequestInputModel
  • RequestResponse
  • TitleCompanyRequest
  • TitleCompanyResponse
  • ValidationError
  • app__src__enrichment__companies__models__common__RequestInputModel
  • app__src__enrichment__person__models__common__RequestInputModel
  • app__src__enrichment__person__models__person_model__PersonModel