Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chatbase Leads API

Retrieve leads captured by a chatbot.

Chatbase Leads API is one of 5 APIs that Chatbase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Leads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://www.chatbase.co/api/v1.

1 operations 1 paths 2 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://www.chatbase.co/api/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Chatbase Leads API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer API key created in the Chatbase dashboard (Workspace Settings - API Keys).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Leads 1

Retrieve leads captured by a chatbot.

GET
/get-leads
Get leads
getLeads 5 params → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Lead (6 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
Lead
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatbase-leads-api-openapi.yml Raw ↑

Other APIs Chatbase publishes across the network.

Chatbase Chat API
Chatbase Chatbots API
Chatbase Contacts API
Chatbase Conversations API