Skip to documentation

Endpoint

GET /api/v1/broadcasts/:id

Fetch broadcast status, aggregate delivery counts, run details, and paginated recipients for a broadcast created by your account.

Required scope

Your API key must allow broadcasts:read. Existing unrestricted keys continue to work.

Query parameters

  • limitnumber
    Recipient page size. Minimum 1, maximum 100, default 20.
  • offsetnumber
    Recipient page offset. Defaults to 0.
  • statusstring
    Optional recipient status filter. Use all to include every status.
  • qstring
    Optional recipient search query.
curl "https://api.techupservices.in/api/v1/broadcasts/broadcast_uuid?limit=50&status=all" \
  -H "Authorization: Bearer tus_live_your_key_here"

Response

The response uses the same detail shape as the dashboard broadcast detail page, including campaign fields, run data, counts, and recipient rows.

{
  "broadcast": {
    "id": "broadcast_uuid",
    "name": "Lead outreach",
    "status": "sending",
    "total_recipients": 42,
    "sent_count": 30,
    "delivered_count": 25,
    "read_count": 10,
    "failed_count": 1
  },
  "current_run": {
    "id": "run_uuid",
    "status": "sending"
  },
  "recipients": [
    {
      "id": "recipient_uuid",
      "name": "Rohan",
      "phone": "+919876543210",
      "status": "delivered"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0
  }
}