Broadcasts
List recipients
Get recipients for this broadcast with delivery status.
GET
/
whatsapp
/
broadcasts
/
{broadcast_id}
/
recipients
List recipients
curl --request GET \
--url https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients"
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://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients', 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://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients",
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://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients"
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://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients")
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{
"data": [
{
"id": "8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f",
"phone_number": "14155550123",
"status": "sent",
"sent_at": "2025-07-15T10:05:23Z",
"delivered_at": "2025-07-15T10:05:30Z",
"read_at": "2025-07-15T10:12:45Z",
"responded_at": "2025-07-15T10:15:00Z",
"created_at": "2025-07-15T10:00:00Z",
"updated_at": "2025-07-15T10:15:00Z",
"template_components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"parameter_name": "first_name",
"text": "Alicia"
},
{
"type": "text",
"parameter_name": "discount_code",
"text": "SAVE25"
}
]
}
]
},
{
"id": "7b8c9d0e-1f2a-3b4c-5d6e-7f8a9b0c1d2e",
"phone_number": "14155550124",
"status": "failed",
"sent_at": "2025-07-15T10:05:30Z",
"failed_at": "2025-07-15T10:05:32Z",
"error_message": "Invalid phone number",
"error_details": {
"error_code": "131047",
"error_subcode": "2494055"
},
"created_at": "2025-07-15T10:00:10Z",
"updated_at": "2025-07-15T10:05:32Z",
"template_components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"parameter_name": "first_name",
"text": "Jane"
},
{
"type": "text",
"parameter_name": "discount",
"text": "SAVE40"
}
]
}
]
}
],
"meta": {
"page": 1,
"per_page": 20,
"total_pages": 1,
"total_count": 2
}
}{
"error": "<string>"
}{
"error": "<string>"
}Was this page helpful?
⌘I
List recipients
curl --request GET \
--url https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients"
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://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients', 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://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients",
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://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients"
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://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/whatsapp/broadcasts/{broadcast_id}/recipients")
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{
"data": [
{
"id": "8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f",
"phone_number": "14155550123",
"status": "sent",
"sent_at": "2025-07-15T10:05:23Z",
"delivered_at": "2025-07-15T10:05:30Z",
"read_at": "2025-07-15T10:12:45Z",
"responded_at": "2025-07-15T10:15:00Z",
"created_at": "2025-07-15T10:00:00Z",
"updated_at": "2025-07-15T10:15:00Z",
"template_components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"parameter_name": "first_name",
"text": "Alicia"
},
{
"type": "text",
"parameter_name": "discount_code",
"text": "SAVE25"
}
]
}
]
},
{
"id": "7b8c9d0e-1f2a-3b4c-5d6e-7f8a9b0c1d2e",
"phone_number": "14155550124",
"status": "failed",
"sent_at": "2025-07-15T10:05:30Z",
"failed_at": "2025-07-15T10:05:32Z",
"error_message": "Invalid phone number",
"error_details": {
"error_code": "131047",
"error_subcode": "2494055"
},
"created_at": "2025-07-15T10:00:10Z",
"updated_at": "2025-07-15T10:05:32Z",
"template_components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"parameter_name": "first_name",
"text": "Jane"
},
{
"type": "text",
"parameter_name": "discount",
"text": "SAVE40"
}
]
}
]
}
],
"meta": {
"page": 1,
"per_page": 20,
"total_pages": 1,
"total_count": 2
}
}{
"error": "<string>"
}{
"error": "<string>"
}
