API reference · Broadcasts

List broadcasts

GET/v1/broadcastsFree

This workspace's broadcasts, newest first.

Query

limit1 to 50

How many to return. Default 10.

Answer

200OK

Errors

Every error has the same shape: see Errors.

Status	Code	When

Request

curl "https://api.walletpassapi.com/v1/broadcasts" \
  -H "Authorization: Bearer $WALLET_API_KEY"

const res = await fetch("https://api.walletpassapi.com/v1/broadcasts", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.WALLET_API_KEY}`,
  },
});
const data = await res.json();

import os

import requests

res = requests.get(
    "https://api.walletpassapi.com/v1/broadcasts",
    headers={"Authorization": f"Bearer {os.environ['WALLET_API_KEY']}"},
)
data = res.json()

<?php

$ch = curl_init("https://api.walletpassapi.com/v1/broadcasts");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 OK

{
  "broadcasts": [
    {
      "id": "bc_m2x8k4q7w1n9p3r5",
      "message": "Double points this weekend",
      "status": "completed",
      "total": 1200,
      "sent": 1198,
      "skipped": 2,
      "failed": 0,
      "lastError": null,
      "filters": {
        "status": "active",
        "template": "gold-member"
      },
      "createdAt": "2026-10-08T19:31:12.000Z",
      "completedAt": "2026-10-08T19:31:12.000Z"
    }
  ]
}