Skip to main content
GET
Get campaign details and recipients

Authorizations

Authorization
string
header
required

Project API key (sk_live… or sk_dev…). Send it as Authorization: Bearer <api_key>.

Path Parameters

_id
string
required

Campaign MongoDB id returned on create

Pattern: ^[a-fA-F0-9]{24}$

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 500
status
enum<string>

Filter paginated recipients by delivery status

Available options:
queued,
sent,
delivered,
read,
failed
phoneNumber
string

Partial phone number search on recipients

Response

Campaign with paginated recipients

success
enum<boolean>
required
Available options:
true
data
object
required