List campaigns

/campaignsGET

Fetches a list of recently created message broadcast campaigns and their execution metrics.

Authorization

BearerAuth *Bearer <token>

API key generated under Account Settings → API Keys (rk_live_...). Send as header Authorization: Bearer <key>.

Response

200 · List of campaigns retrieved successfully

items?object

Show properties

id?integer

Example: 12

name?string

Example: "October Flash Sale"

subject?string

Example: "50% Discount Today"

status?string

Example: "sent"

campaign_type?string

Example: "broadcast"

routing_strategy?"whatsapp_only" | "sms_only" | "whatsapp_first" | "smart_fallback"

Example: "smart_fallback"

sent_count?integer

Example: 940

delivered_count?integer

Example: 934

failed_count?integer

Example: 6

actual_cost?number (float)

Example: 4700

created_at?string (date-time)

Example: "2026-07-20T10:00:00Z"

channel?string

Example: "whatsapp"

401 · Unauthorized

success *boolean

Example: false

error *string

Human-readable error message explaining the failure reason.

Example: "Recipient not reachable on WhatsApp."

error_code *string

Stable machine-readable error code.

Example: "recipient_not_on_whatsapp"

Request example

curl -X GET "https://convert.ruut.chat/api/v1/campaigns" \
  -H "Authorization: Bearer <token>"

Response example

[
  {
    "id": 12,
    "name": "October Mega Flash Sale",
    "subject": "Exclusive 50% Off Today",
    "status": "sent",
    "campaign_type": "broadcast",
    "routing_strategy": "smart_fallback",
    "sent_count": 940,
    "delivered_count": 934,
    "failed_count": 6,
    "actual_cost": 4700,
    "created_at": "2026-07-20T10:00:00Z",
    "channel": "whatsapp"
  }
]