PaidGoods
API referenceCustomers

Export customers as CSV (same search and filters as the list)

GET
/v1/stores/{storeId}/customers/export.csv

Authorization

AuthorizationBearer <token>

API key from Settings → API keys

In: header

Path Parameters

storeId*string

Query Parameters

q?string
Lengthlength <= 200
sort?string
Default"recent"

Value in

  • "recent"
  • "spend"
  • "orders"
account?string

Value in

  • "account"
  • "guest"
newsletter?string

Value in

  • "subscribed"
  • "not_subscribed"
buyers?string

Value in

  • "buyers"
  • "no_orders"
page?integer
Range1 <= value <= 9007199254740991
Default1
perPage?integer
Range1 <= value <= 200
Default25

Response Body

application/json

curl -X GET "https://example.com/v1/stores/string/customers/export.csv"
Empty