Skip to content
Reference/Broadcast Groups/Get Broadcast Recipients

Get Broadcast Recipients

GEThttps://public.leadpattern.com/groups/broadcasts/:id/recipients
Plan: broadcastapplication/json60 req/min

Retrieve the per-recipient delivery breakdown for a broadcast. Filter by status: sent, delivered, failed, replied, noResponse, unread.

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Path Parameters

1 field
idstring
required
Broadcast ID.

Query Parameters

4 fields
statusenum
optional
Filter by recipient status.
Allowed values:
sentdeliveredfailedrepliednoResponseunread
pagenumber
optionaldefault: 1
Page number.
limitnumber
optionaldefault: 20
Results per page.
searchstring
optional
Search by contact name/phone.

Responses

JSON Response
{
  "type": "success",
  "data": {
    "results": [
      {
        "waId": "9195XXXXXXXX",
        "status": "delivered",
        "repliedAt": null
      }
    ],
    "total": 150
  }
}

Sample Request

{
  "page": 1,
  "limit": 20
}