Skip to main content

Lead API

The Lead API is a read-only REST API for pulling your captured lead and visitor data into your own tools — a CRM, a data warehouse, or an internal dashboard. Where webhooks push events to you as they happen, the Lead API lets you fetch data on your own schedule.

Authentication​

Every request needs your company's Lead API key, sent in the x-api-key header. Generate (or regenerate) the key in-app: go to Integrations, open Webhooks, and switch to the API Key tab. Your company is resolved from the key, so there is nothing else to configure.

warning

The visitor endpoints that were previously open now require this API key. If you were calling them without one, generate a key and add the x-api-key header to your requests.

What You Can Fetch​

  • List lead visitors — a paginated list of your enriched lead and visitor records, filterable and sortable.
  • Visitor counts — aggregate totals for leads and visitors.
  • A lead's transcript — every conversation held with one lead (chats and calls), merged in chronological order.
info

The full endpoint reference with parameters, response shapes, and copyable examples lives in-app on the Documentation tab of the same Webhooks screen.

Next Steps​