DocsAPI Reference

API Reference

Build on top of BeeCastly with our full-featured REST API. Manage contacts, send messages, create campaigns, and configure webhooks programmatically.

Base URL

https://beecastly.com/api

All API endpoints are relative to this base URL. Requests must include a valid API key or JWT token.

Quick Start

curl -X GET https://beecastly.com/api/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-tenant-id: YOUR_TENANT_ID" \
  -H "Content-Type: application/json"

Authentication

All requests require authentication via one of:

API Key — Pass in the Authorization: Bearer YOUR_API_KEY header
JWT Token — Obtained from POST /auth/login

Additionally, include your tenant ID: x-tenant-id: YOUR_TENANT_ID

See full authentication guide →

API Endpoints

Authentication

Contacts

CRUD operations, tags, segments, custom fields

Messages

Send WhatsApp, Email, SMS. Fetch conversations

Campaigns

Create, schedule, and track campaigns

Webhooks

Event subscriptions, payloads, verification

Bots

AI bot sessions, messages, and training data

Response Format

All responses follow a consistent JSON format:

// Success
{
  "success": true,
  "data": { ... }
}

// Error
{
  "success": false,
  "error": "Error message description"
}

Rate Limits

Free tier: 100 requests/minute

Pro tier: 1,000 requests/minute

Enterprise: Custom limits

Rate limit headers are included in every response: X-RateLimit-Remaining