PaidGoods
API referenceMarketing

Per-recipient send records

GET
/v1/stores/{storeId}/marketing/campaigns/{campaignId}/recipients

Authorization

AuthorizationBearer <token>

API key from Settings → API keys

In: header

Path Parameters

storeId*string
campaignId*string

Query Parameters

page?integer
Range1 <= value <= 9007199254740991
Default1
perPage?integer
Range1 <= value <= 200
Default25
state?|
Default"all"
q?string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/stores/string/marketing/campaigns/string/recipients"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",      "email": "string",      "state": "pending",      "sentAt": "string",      "openedAt": "string",      "openCount": -9007199254740991,      "firstClickAt": "string",      "clickCount": -9007199254740991,      "unsubscribedAt": "string",      "error": "string"    }  ],  "pagination": {    "page": -9007199254740991,    "perPage": -9007199254740991,    "total": -9007199254740991  }}