List Scheduled/Active Broadcasts & Messages
GEThttps://public.leadpattern.com/scheduled-broadcasts
Combined, paginated list of scheduled broadcasts and one-off scheduled messages. view=active returns scheduled|processing|paused; view=completed returns completed|failed|cancelled.
- The filter value here is type=chat, but the path param on pause/resume/cancel is :type=message. Same thing, two spellings.
Headers
1 fieldAuthorizationstringrequired
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.
Query Parameters
5 fieldsviewenumoptionaldefault:
activeWhich status set to return.
Allowed values:
activecompletedtypeenumoptional
Filter by item type.
Allowed values:
broadcastchatpagenumberoptionaldefault:
1Page number.
limitnumberoptionaldefault:
20Results per page.
searchstringoptional
Search by recipient or template.
Responses
JSON Response
{
"type": "success",
"data": [
{
"_id": "664abc...",
"type": "broadcast",
"recipientName": "VIP Customers",
"templateName": "promo_offer",
"status": "processing",
"scheduledAt": "2026-07-01T09:00:00.000Z"
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 20,
"totalPages": 1
}
}Sample Request
{
"view": "active"
}