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 Contacts API

Manage contacts and custom attributes for a chatbot.

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

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

This API exposes 8 operations across 4 paths, and defines 5 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.

8 operations 4 paths 5 schemas 1 DELETE3 GET1 PATCH2 POST1 PUT

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 Contacts 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 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contacts 8

Manage contacts and custom attributes for a chatbot.

POST
/chatbots/{chatbotId}/contacts
Create contacts
createContacts 1 param body → 200401
GET
/chatbots/{chatbotId}/contacts
List contacts
listContacts 3 params → 200401
GET
/chatbots/{chatbotId}/contacts/{contactId}
Get a contact
getContact 2 params → 200401
PATCH
/chatbots/{chatbotId}/contacts/{contactId}
Update a contact
updateContact 2 params body → 200401
DELETE
/chatbots/{chatbotId}/contacts/{contactId}
Delete a contact
deleteContact 2 params → 200401
POST
/chatbots/{chatbotId}/custom-attributes
Create a custom attribute
createCustomAttribute 1 param body → 200401
GET
/chatbots/{chatbotId}/custom-attributes
Get the custom-attribute schema
getCustomAttributes 1 param → 200401
PUT
/chatbots/{chatbotId}/custom-attributes/{name}
Update a custom attribute
updateCustomAttribute 2 params body → 200401

Schemas 5

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

CustomAttribute
object
2 properties 2 required
Status
object
2 properties
ContactInput
object
4 properties
Contact
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatbase-contacts-api-openapi.yml Raw ↑

Other APIs Chatbase publishes across the network.

Chatbase Chat API
Chatbase Chatbots API
Chatbase Conversations API
Chatbase Leads API