Search for contacts.

post https://api.visualvisitor.com/api/v1/whoToContact/contact

Queried customer must have a +PlusEmployee plan enabled.
Minimal scope required: "customers.read".

Query Params

customerId

string | null

Optional query parameter, allowing partners to perform this action on behalf of their customer.

api-version

string | null

Body Params

The JSON object containing the search filters.

page

int32 | null

Optional, the current page number for pagination, with a maximum allowed value of 50.
This value is ignored by Bulk operations.

pageSize

int32 | null

Optional, the number of records per page for pagination, with a maximum allowed value of 200.
This value is ignored by Bulk operations.

jobTitles

array of strings | null

Optional, the list of contact job titles to filter by.

jobTitles

jobLevelValues

array of strings | null

Optional, the list of contact job levels to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/jobLevels.

jobLevelValues

jobFunctionValues

array of strings | null

Optional, the list of contact job functions to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/jobFunctions.

jobFunctionValues

jobStartDateValue

string | null

Optional, the start date of the contact's current job.
Required values can be retrieved from the endpoint: /api/v1/reference/jobStartDates.

jobsRecentlyChanged

boolean | null

Optional, Indicates if the contact has changed jobs recently.

companyNames

array of strings | null

Optional, the list of company names to filter by.

companyNames

companyWebsites

array of strings | null

Optional, the list of company websites to filter by.

companyWebsites

companyIndustryValues

array of strings | null

The list of company industries to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/companyIndustries.

companyIndustryValues

companySicValues

array of strings | null

Optional, the list of company SIC codes to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/companySics.

companySicValues

companyNaicsValues

array of strings | null

Optional, the list of company NAICS codes to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/companyNaics.

companyNaicsValues

companyEmployeeSizeVaules

array of strings | null

Optional, the list of company size identifiers to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/companyEmployeeSizes.

companyEmployeeSizeVaules

companyRevenueBandValues

array of strings | null

Optional, the list of company revenue bands to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/companyRevenueBands.

companyRevenueBandValues

addressTypeValues

array of strings | null

Optional, the list of address types to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/addressTypes.

addressTypeValues

countryValues

array of strings | null

Optional, the list of countries to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/countries.

countryValues

stateValues

array of strings | null

Optional, the list of states to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/states.

stateValues

cities

array of strings | null

Optional, the list of cities to filter by.

cities

zipCodes

array of strings | null

Optional, the list of zip codes to filter by.

zipCodes

firstName

string | null

Optional, the first name of the contact.

lastName

string | null

Optional, the last name of the contact.

genderValues

array of strings | null

Optional, the list of genders to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/genders.

genderValues

almaMater

array of strings | null

Optional, the list of alma maters (schools) to filter by.

almaMater

fromAge

int32 | null

Optional, the minimum age of the contact.

toAge

int32 | null

Optional, the maximum age of the contact.

skills

array of strings | null

Optional, the list of contact skills to filter by.

skills

formerEmployer

array of strings | null

Optional, the list of former employers to filter by.

formerEmployer

personalEmailOnly

boolean | null

Optional, Indicates if only personal emails should be included in the search.

cellPhoneRequired

boolean | null

Optional, Indicates if a cell phone number is required.

urlsToSuppress

array of strings | null

Optional, the list of URLs to suppress from the search.

urlsToSuppress

titlesToSuppress

array of strings | null

Optional, the list of titles to suppress from the search.

titlesToSuppress

emailsToSuppress

array of strings | null

Optional, the list of emails to suppress from the search.

emailsToSuppress

primaryContactsOnly

boolean | null

Optional, Indicates if only primary contacts should be included in the search.

professionalEmailRequired

boolean | null

Optional, Indicates if professional emails are required.

emailConfidenceScore

int32 | null

Optional, the minimum email confidence score required for the search.

deterministicEmailsOnly

boolean | null

Optional, Indicates that only contacts using catch-all professional email addresses.

phoneRequired

boolean | null

Indicates if the contact must have a phone number.

Headers

X-Version

string | null

Responses

Response body

object

contacts

array of objects

The list of contacts returned by the search.

contacts

object

string

Unique identifier for the contact.

firstName

string

First name of the contact.

lastName

string

Last name of the contact.

title

string

Job title of the contact.

linkedinUrl

string

LinkedIn profile URL of the contact.

facebook

string

Facebook profile URL of the contact.

twitterUrl

string

Twitter profile URL of the contact.

city

string

City where the contact is located.

state

string

State where the contact is located.

country

string

Country where the contact is located.

companyName

string

Name of the company where the contact works.

companyId

string

Unique identifier of the company.

hasDirectPhone

boolean

Indicates if the contact has a direct phone number.

hasMobilePhone

boolean

Indicates if the contact has a mobile phone number.

hasCompanyEmail

boolean

Indicates if the contact has a company email address.

hasPersonalEmail

boolean

Indicates if the contact has a personal email address.

isSavedContact

boolean

Indicates if the contact has been saved by the user.

lastUpdated

date-time

The date the contact information was last updated.

hasHqAddress

boolean

Indicates if the company has a headquarters address.

hasLocalAddress

boolean

Indicates if the company has a local address.

hasPhysicalAddress

boolean

Indicates if the company has a physical address.

hqCountry

string

Country of the company headquarters.

hqState

string

State of the company headquarters.

hqCity

string

City of the company headquarters.

localCountry

string

Country of the company's local office.

localState

string

State of the company's local office.

localCity

string

City of the company's local office.

physicalCountry

string

Country of the company's physical office.

physicalState

string

State of the company's physical office.

physicalCity

string

City of the company's physical office.

savedFrom

string

Indicates the source from which the contact was saved.

totalRecords

int64

Total rows found by the query

page

int32

Pagination page number of the query

pageSize

int32

Pagination page size of the query

hasNextPage

boolean

Indicates if there are more pages to be fetched

500

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.visualvisitor.com/api/v1/whoToContact/contact \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400

401

403

404

429