List coupons
Newest first. Search matches the name or prefix.
GET
Newest first. Search matches the name or prefix.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
page?integerStarts at 1
Range
1 <= valueDefault
1pageSize?numberOne of 10, 25, 50, 100
Default
25q?stringSearch
Length
1 <= length <= 200store?stringComma-separated ids
status?stringComma-separated, any of: active, ended, archived
OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/coupons'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "store": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "platform": "string", "currency": "string" }, "name": "string", "source": "platform", "kind": "personal", "quantity": 0, "prefix": "string", "valueType": "percentage", "value": 0, "minimumSubtotal": { "amount": 0, "currency": "str" }, "validity": { "type": "days", "days": 1 }, "combinesWith": { "orderDiscounts": true, "productDiscounts": true, "shippingDiscounts": true }, "reissue": "after_use_or_expiry", "status": "active", "externalId": "string", "adminUrl": "http://example.com", "importSkipped": 0, "codes": { "available": 0, "assigned": 0, "used": 0, "expired": 0, "pending": 0, "failed": 0 }, "createdAt": "2019-08-24T14:15:22Z", "archivedAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0}