Skip to main content
ChatBridge’s public REST API (/api/v1/) lets you integrate contacts, conversations, messages, templates, tickets, and WhatsApp Flows into your own systems — or hand it to an AI agent as a tool-calling surface. It’s the same API ChatBridge’s own dashboard is built on top of, exposed as a versioned, scoped, rate-limited public contract.

Quickstart

Create an API key and make your first call in under 5 minutes.

Authentication

How API keys, scopes, and the Bearer token header work.

API Reference

Every endpoint, request/response shape, and example.

Rate Limits

60 requests/minute per key, independent of your plan.

MCP Server

Connect your own AI agent over the Model Context Protocol — any model you like.

Changelog

Every additive change, fix, and security tightening, newest first.

What you can do today

  • Contacts — list, create, update, delete, bulk import.
  • Contact notes — read and add internal notes on a contact, with team-member mentions.
  • Custom fields — manage the typed custom-field schema your contacts and conversations carry.
  • Conversations — list, read message history, update status/priority/tags/assignment.
  • Messages — send text, media, interactive, and template messages.
  • Broadcasts — draft, preview, confirm, schedule, and unschedule template broadcasts — creating and sending are always two separate calls.
  • Templates — list your approved/pending WhatsApp message templates.
  • Macros — list your one-click action bundles and run one against a conversation or ticket.
  • Team — list members and team inboxes.
  • Catalogue — read your connected Meta product catalogue.
  • Account health — aggregated phone and template quality ratings plus a 7-day alert history.
  • Phone numbers — list the numbers and business accounts your key can send from.
  • Tickets — full CRUD, comments, activity log, escalation, and pipeline/stage management — the same shared-inbox ticketing system the dashboard uses.
  • WhatsApp Flows — read-only for now: list, detail, metrics, and submission data.

Versioning

/api/v1/ is the only version today. Non-breaking changes (new fields, new endpoints, new scopes) ship straight into v1 without a version bump. A /api/v2/ deprecation policy will be published here before any breaking change ships.

Where this API is going

ChatBridge is building an LLM-agnostic WhatsApp agent runtime — bring your own AI model, plug it into this API or the MCP server built directly on top of it, and let it read and act on your WhatsApp inbox with full CRM context. Everything documented here is designed for exactly that use case, not just for human developers writing one-off integrations.