> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gameball.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Customer Coupons

> Retrieve available coupons for a customer in Gameball with detailed information.

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.

<Warning>
  **Security**: Requires **apikey** and **secretkey** headers.
</Warning>


## OpenAPI

````yaml GET /api/v4.0/integrations/customers/{customerId}/coupons
openapi: 3.1.0
info:
  title: Gameball API
  description: >-
    Gameball REST API v4.0 - Complete API reference for integrating loyalty,
    gamification, and customer engagement features
  version: 4.0.0
servers:
  - url: https://api.gameball.co
security:
  - bearerAuth: []
paths:
  /api/v4.0/integrations/customers/{customerId}/coupons:
    get:
      summary: Get Customer Coupons
      description: >-
        Retrieve customer's available coupons with detailed information on each
        coupon's type, status, and usage.
      operationId: getCustomerCoupons
      parameters:
        - name: customerId
          in: path
          required: true
          schema:
            type: string
          description: Unique identifier for the customer
      responses:
        '200':
          description: Customer coupons found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerCouponsResponse'
      security:
        - apiKey: []
          secretKey: []
components:
  schemas:
    CustomerCouponsResponse:
      type: object
      properties:
        coupons:
          type: array
          description: List of coupon objects associated with the customer
          items:
            type: object
            properties:
              name:
                type: string
                description: Name of the coupon
              code:
                type: string
                description: The coupon code that the customer will use
              value:
                type: number
                description: The monetary value or percentage value of the coupon
              type:
                type: string
                description: Type of the coupon
                enum:
                  - Free Shipping
                  - Fixed Rate Discount
                  - Percentage
                  - Free Product
                  - Custom
                  - Percentage-based Fees Discount
                  - Percentage-based Cashback
              target:
                type: string
                description: How the coupon is associated with the customer
                enum:
                  - Online
                  - POS
                  - Permanent
                  - Reward
                  - Automation
              currency:
                type: string
                description: Currency code if the coupon has a fixed monetary value
              startDate:
                type: string
                format: date-time
                description: The date and time when the coupon becomes valid
              expiryDate:
                type: string
                format: date-time
                description: The date and time when the coupon will expire
              isExpired:
                type: boolean
                description: Indicates if the coupon has expired
              isActive:
                type: boolean
                description: Status of the coupon, whether it is active or not
              usageLimit:
                type: number
                description: The total number of times the coupon can be used
              limitPerCustomer:
                type: number
                description: The number of times a single customer can use the coupon
              usedCount:
                type: number
                description: Number of times the coupon has been used
              customerUsedCount:
                type: number
                description: Number of times the coupon has been used by this customer
              isAvailableToUse:
                type: boolean
                description: >-
                  Flag determining whether coupon can be used by customer at
                  given time
              iconPath:
                type: string
                description: Path or URL to the icon image for the coupon
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: apikey
    secretKey:
      type: apiKey
      in: header
      name: secretkey

````