Skip to main content
GET
Get Customer Coupons
This API retrieves a customer’s available coupons in Gameball, offering detailed information on each coupon’s type, status, and usage. Use this endpoint to access current coupon data associated with the customer for better engagement.
Security: Requires apikey and secretkey headers.

Coupon lock state

Each coupon includes isLocked, a boolean that reflects the coupon’s current lock state. It is true while a lock is active and false when the coupon is not locked.
A locked coupon still returns valid: true from Validate Single Coupon and Validate Multiple Coupons when that request does not lock the coupon. Omit lock, lockReference, and lockDuration — for example, do not send "lock": true, "lockReference": "123", and "lockDuration": 1440.

Authorizations

apikey
string
header
required
secretkey
string
header
required

Path Parameters

customerId
string
required

Unique identifier for the customer

Response

200 - application/json

Customer coupons found

coupons
object[]

List of coupon objects associated with the customer