List recipients

GET/v1/campaigns/{id}/recipients

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

The recipient snapshot with per-recipient outcome (and A/B variant when an experiment ran).

Path parameters

idstringrequired
Campaign id.

Query parameters

limitinteger
statusstring
pendingsentskipped

Response

Recipients.

dataobject[]required
- campaignRecipientIdstringrequired
- campaignIdstringrequired
- contactIdstring | null
- emailemailrequired
- emailIdstring | null
  The send-log id once the message went out.
- statusenumrequired
  pendingsentskipped
- variantenum
  A/B variant, when an experiment is running.
  abholdnull
- createdAtdate-timerequired

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

401Missing or invalid API key.
404Not found.
422Request validation failed (code `validation_error`, 422).

Request

curl https://api.volanea.com/v1/campaigns/id_123/recipients?limit=100&status=pending \
  -H "Authorization: Bearer sk_..."

Response

200 · application/json

{
  "success": true,
  "data": {
    "data": [
      {
        "campaignRecipientId": "<campaignRecipientId>",
        "campaignId": "cmp_2b8e",
        "contactId": "con_5e90",
        "email": "ada@example.com",
        "emailId": "em_1c4f",
        "status": "pending",
        "variant": "a",
        "createdAt": "2026-01-01T09:00:00.000Z"
      }
    ]
  }
}

92 endpoints · OpenAPI document