DocsRiferimento API

Riferimento API

Costruisci su BeeCastly con la nostra API REST completa. Gestisci i contatti, invia messaggi, crea campagne e configura i webhook in modo programmatico.

URL di base

https://beecastly.com/api/v1

Every endpoint that accepts an API key lives under /api/v1. The key identifies your workspace — there is no tenant header to send.

Avvio rapido

curl "https://beecastly.com/api/v1/contacts?page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY"

Autenticazione

Send your API key in the x-api-key header. Create keys under Settings → API Keys and choose their access when you create them:

Read only — GET requests.
Read & write — also POST: send messages, create contacts.

Consulta la guida completa all'autenticazione →

Endpoint API

Autenticazione

Accedi, registrati, chiavi API, token JWT

Contatti

Operazioni CRUD, tag, segmenti, campi personalizzati

Messaggi

Invia WhatsApp, e-mail, SMS. Recupera conversazioni

Webhook

Iscrizioni a eventi, payload, verifica

Formato della risposta

Ogni risposta è in JSON con la stessa struttura:

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

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

Limiti di velocità

Two limits apply to every API-key request, both set by your plan:

Per key, per minute — the plan's ceiling, or the key's own limit if lower. Over it: 429 with code API_KEY_RATE_LIMITED.
Per workspace, per day — shared by all your keys, resets at 00:00 UTC. Over it: 429 with code API_DAILY_LIMIT and a Retry-After header. Every response carries X-Daily-Limit and X-Daily-Remaining.

Plan	Requests / minute (per key)	Requests / day (workspace)	Webhook endpoints
Free	5	100	2
Starter	20	2,500	10
Growth	100	15,000	30
Pro	300	60,000	100
Agency	1,000	500,000	Unlimited

The BeeCastly Chrome extensions use their own keys and do not count toward the daily allowance.