List a coupon’s codes
Newest first. Search matches the code or the email it was handed out to.
GET
Newest first. Search matches the code or the email it was handed out to.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringFormat
uuidpage?integerStarts at 1
Range
1 <= valueDefault
1pageSize?numberOne of 10, 25, 50, 100
Default
25q?stringSearch
Length
1 <= length <= 200status?stringComma-separated, any of: pending, available, assigned, used, expired, failed
OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/coupons/497f6eca-6276-4993-bfeb-53cbbbba6f08/codes'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "code": "string", "status": "pending", "profile": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string" }, "order": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": "string" }, "assignedAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "usedAt": "2019-08-24T14:15:22Z", "error": "string", "createdAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0}