Qualified API overview

Qualified offers two APIs: the Enterprise API, which moves data between Qualified and your other systems, and the Client-side JavaScript API, which controls the visitor experience on your website in real time. This guide explains what each one is for and how to get started.

Enterprise API

The Enterprise API is a server-side REST API for connecting Qualified to your data warehouse, CDP, business intelligence (BI) tools and other systems. Use it to export Qualified activity for your own reporting and analysis, or to send lead and company data into Qualified from sources other than your CRM.

The official Qualified API documentation has the full endpoint reference, authentication details, rate limits and code samples.

What you can do with the Enterprise API

• Export activity data (Leads, Sessions, Conversations, Messages, Meetings, Emails): Pull Qualified records into your own systems on your own schedule. The records share IDs, so your data team can join them to build funnel, attribution and rep-performance reporting.

• Send data into Qualified (Leads, Companies, Bulk): Create or update leads and companies one at a time, or many at once with a bulk job. A company update sets account-level field values for every lead on that domain. The API writes to fields that already exist in Qualified, so create any new fields in the app first. You can list the available lead and company fields through the API.

• Utility (GDPR Deletion Requests, Cancel Meeting): Available to all customers upon request, these endpoints let you automate specific processes, like managing data privacy compliance or syncing meeting cancellations with other systems. A GDPR deletion request accepts up to 5,000 email addresses per request.

• Legacy reporting (Bot Conversations, Rep Conversations): These earlier endpoints remain supported for existing integrations. For new integrations, use the Conversations, Messages and Meetings endpoints.

How to get started with the Enterprise API

1. Identify your goal: Decide whether you need to export data for reporting, send data into Qualified, or automate a utility process.

2. Request endpoint access: Reach out to your Qualified Success Architect to discuss your use case and request access to the endpoints you need.

3. Generate your API key: Once your QSA has confirmed access is enabled, generate your API key by following the steps in Generate API keys. Each key reaches only the endpoints its scopes allow.

4. Use the technical documentation: With your key and enabled endpoints, your development team can use the official Qualified API documentation for detailed specifications and code examples.

Client-side JavaScript API

The Client-side API is a set of JavaScript commands that you add directly to your website's code. It gives you real-time control over the Qualified messenger for each individual visitor, allowing you to create a highly personalized and dynamic experience.

Key capabilities

• Identify visitors: Pass data you already have about a visitor (like their name or email from your marketing automation platform) into Qualified using the identify call to personalize their experience.

• Handle events: Trigger your own custom scripts or send data to another system when a visitor performs an action in the messenger, like starting a chat or booking a meeting, using the handleEvents function.

• Control the messenger: Programmatically open the messenger, show specific experiences, or adapt to navigation on a single-page application (SPA) using commands like open, showExperience, and page.

• Retrieve visitor data: Pull information that Qualified has captured about a visitor during their session into other on-page tools (like a support chat) using the getIdentity function.

How to get started with the client-side API

For a complete list of functions, implementation instructions, and detailed code samples, see Client-side API.