Visual Visitor Platform API

What's Inside?

The Visual Visitor Platform API empowers developers to seamlessly integrate Visual Visitor's application methods and data into their own applications. This documentation provides:

A comprehensive list of API methods
Detailed request and response object specifications
Examples in multiple programming languages
An interactive API testing portal

Getting Started

The API follows a RESTful architecture and supports standard HTTP methods:

Method	Action
`GET`	Retrieve data
`POST`	Create a new resource
`PATCH`	Update part of a resource
`PUT`	Replace a resource
`DELETE`	Remove a resource

The base URL for all API requests is: https://api.visualvisitor.com/api

Note: Responses are communicated using HTTP status codes for consistent feedback.

Authentication

The API uses API keys for authentication. Include the API key in the HTTP Authorization header. Each account can create up to 5 API keys.

How to Generate an API Key

Navigate to the API Keys section in your Visual Visitor Application under Configuration > API Integration.
Click Create New Key, and assign it a descriptive name.
Copy the generated key and store it securely. ⚠️ Note: You will not be able to view the key again after creation.

Usage Policies

Rate Limits

IP Limit: 200 requests per 20 minutes.
API Key Limit: 5,000 calls per day.

Exceeding these limits returns an HTTP status code 429 (Too Many Requests).

Pagination

For search queries, pagination supports up to 50 pages with a maximum page size of 200 results.

Bulk Operations

Bulk functionality allows for submitting large search jobs. Once processed, results can be downloaded via a provided link.

Important: The "Who To Contact" service requires credits for detailed contact information. Bulk jobs also require confirmation before finalizing.

API Categories

Partners

Manage Customers: Create and manage customer accounts.
Available Services: View services available for managing customers.

Manage Users

Manage users for your company or customers’ companies.

PlusEmployee

Leads: Query and export leads from the +Employee product.
Who To Contact: Access detailed company and contact information.
Ideal Customer Profile: Define and manage criteria for ideal leads.

PlusPerson

Leads: Query and export leads from the +Person product.

Configuration

Customer: Access installation codes and manage cookie consent.
Excluded IPs: Manage IP addresses excluded from tracking.
Known Customers: Maintain a list of known customer emails.
Suppression List: Manage a list of leads to ignore.

Reference Lists

Lookup lists for filters requiring specific data formats.

Developer Support

This API documentation is designed to make your integration process straightforward and efficient. Should you encounter any issues or have further questions, our support team is here to assist.

Start exploring the power of the Visual Visitor Platform API today!