Search for Known Customer.

post

https://api.visualvisitor.com/api/v1/config/knownCustomer/search

Minimal scope required: "customers.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.

DTO for filtering known customer search results based on various criteria.

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.

emailAddress

string | null

Optional, the email address of the customer being searched.

hashedAddress

string | null

Optional, the SHA-256 hashed email address of the customer being searched.

firstName

string | null

Optional, the first name of the customer being searched.

lastName

string | null

Optional, the last name of the customer being searched.

dateAddedFrom

date-time | null

Optional, the starting date for filtering customers based on when they were added.

dateAddedTo

date-time | null

Optional, the ending date for filtering customers based on when they were added.

Headers

X-Version

string | null

Responses

500

200

400

401

403

404

429