Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
coupons
Get Customer Coupons
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/coupons \
  --header 'apikey: <api-key>'
{
  "coupons": [
    {
      "name": "<string>",
      "code": "<string>",
      "value": 123,
      "type": "Free Shipping",
      "target": "Online",
      "currency": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "expiryDate": "2023-11-07T05:31:56Z",
      "isExpired": true,
      "isActive": true,
      "usageLimit": 123,
      "limitPerCustomer": 123,
      "usedCount": 123,
      "customerUsedCount": 123,
      "isAvailableToUse": true
    }
  ]
}
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.

Authorizations

​
apikey
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