Campaigns
List campaign recipients
Returns a paginated list of recipients for a campaign run, optionally filtered by status.
Returns a paginated list of recipients for a campaign run, optionally filtered by status.
Authorization
apiKey x-api-key<token>
In: header
Path Parameters
id*string
Match
^camp_[0-9a-hjkmnp-tv-z]{16,24}$runId*string
Match
^crun_[0-9a-hjkmnp-tv-z]{16,24}$Query Parameters
status?|null
page?string|null
limit?string|null
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/campaigns/string/runs/string/recipients"{ "items": [ { "id": "string", "runId": "string", "contactId": "string", "status": "pending", "messageId": "string", "failureReason": "string", "skippedReason": "unsubscribed", "createdAt": "string", "updatedAt": "string" } ], "pagination": { "page": 0, "limit": 0, "total": 0, "totalPages": 0 }}