Search for leads.

post

https://api.visualvisitor.com/api/v1/plusEmployee/leads

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

Contains filter used to retrieve Leads for +PlusEmployee product.

page

int32 | null

Optional, the current page number for pagination, with a maximum allowed value of 50.
Not used for bulk operations.

pageSize

int32 | null

Optional, the number of records per page for pagination, with a maximum allowed value of 200.
Not used for bulk operations.

visitBeginDate

date-time | null

Optional, search by the start date of the visit range.

visitEndDate

date-time | null

Optional, search by the end date of the visit range.

jobTitles

array of strings | null

Optional, search by the visitor's job title.

jobTitles

companyNames

array of strings | null

Optional, search by company names.

companyNames

companyDomains

array of strings | null

Optional, search by company domains.

companyDomains

companyIndustries

array of strings | null

Optional, search by company industries.

companyIndustries

companyEmpoyeeSizeRanges

array of strings | null

Optional, search by company employee size range.
Required values can be retrieved from the endpoint: /api/v1/reference/companyEmployeeSizes.

companyEmpoyeeSizeRanges

companyRevenueBandRanges

array of strings | null

Optional, search by company revenue band range.
Required values can be retrieved from the endpoint: /api/v1/reference/companyRevenueBands.

companyRevenueBandRanges

firstName

string | null

Optional, search by the visitor's first name.

lastName

string | null

Optional, search by the visitor's last name.

emailAddress

string | null

Optional, search by the visitor's email address.

residentStates

array of strings | null

Optional, search for visitors in matching states.
Required values can be retrieved from the endpoint: /api/v1/reference/states.

residentStates

residentCities

array of strings | null

Optional, search for visitors in matching cities.

residentCities

residentZipCodes

array of strings | null

Optional, search for visitors in matching ZIP codes.

residentZipCodes

domains

array of strings | null

Optional, search for visitors who visited a site with a matching domain.

domains

referralSources

array of strings | null

Optional, search for visitors who came from matching referral sources.

referralSources

keywords

array of strings | null

Optional, search for visitors with matching keywords in their searches.

keywords

ipAddresses

array of strings | null

Optional, search for visitors from matching IP addresses.

ipAddresses

pageViewed

string | null

Optional, search for visitors who viewed a matching page.

Headers

X-Version

string | null

Responses

500

Language

Credentials

Header

Loading…

Response

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

application/json

200

400

401

403

404

429