PaidGoods
API referenceMarketing

List marketing contacts

GET
/v1/stores/{storeId}/marketing/contacts

Authorization

AuthorizationBearer <token>

API key from Settings → API keys

In: header

Path Parameters

storeId*string

Query Parameters

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

Value in

  • "all"
  • "subscribed"
  • "unsubscribed"

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/stores/string/marketing/contacts"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "email": "string",      "name": "string",      "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",      "consent": true,      "consentSource": "checkout",      "consentAt": "string",      "unsubscribedAt": "string",      "unsubscribeSource": "link",      "createdAt": "string"    }  ],  "pagination": {    "page": -9007199254740991,    "perPage": -9007199254740991,    "total": -9007199254740991  }}