Get broadcast details

Poll overall progress and metrics for a broadcast.

Use this endpoint to monitor broadcast progress and get delivery statistics.

GET /whatsapp_broadcasts/{broadcast_id}

Get broadcast details

cURL

curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_broadcasts/{broadcast_id} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://app.kapso.ai/api/v1/whatsapp_broadcasts/{broadcast_id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.kapso.ai/api/v1/whatsapp_broadcasts/{broadcast_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/whatsapp_broadcasts/{broadcast_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kapso.ai/api/v1/whatsapp_broadcasts/{broadcast_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.kapso.ai/api/v1/whatsapp_broadcasts/{broadcast_id}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/whatsapp_broadcasts/{broadcast_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

draft_broadcast

{
  "data": {
    "id": "5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c",
    "name": "July Promo",
    "status": "draft",
    "started_at": null,
    "completed_at": null,
    "created_at": "2025-07-14T15:00:00Z",
    "updated_at": "2025-07-14T15:00:00Z",
    "whatsapp_config_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
    "whatsapp_template": {
      "id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
      "name": "july_promo_template",
      "language_code": "en_US",
      "category": "MARKETING",
      "status": "approved"
    },
    "total_recipients": 0,
    "sent_count": 0,
    "failed_count": 0,
    "delivered_count": 0,
    "read_count": 0,
    "responded_count": 0,
    "pending_count": 0,
    "response_rate": 0,
    "stats": {
      "total": 0,
      "sent": 0,
      "failed": 0,
      "delivered": 0,
      "read": 0,
      "responded": 0,
      "pending": 0
    }
  }
}

Authorizations

X-API-Key · string · header · required

Your project API key

Path Parameters

broadcast_id · string<uuid> · required

Broadcast ID

Response

200

application/json

Broadcast details

data · object

WhatsApp broadcast campaign

Show child attributes