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

# List issued coupons

> List issued coupons (RewardRedemption instances) for the company — both loyalty-reward redemptions (origin_type=loyalty_reward, customer spent points) and marketing claims (origin_type=marketing, no points spent). Filter by status, customer_id, origin_type, reward_id, or coupon code.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/coupons/issued/
openapi: 3.0.3
info:
  title: Zupy API v2
  version: 2.0.0
  description: >-
    Zupy API v2 — versioned, gateway-aware API with envelope responses, RFC 7807
    errors, and multi-auth support (JWT, API Key, Device Key).
servers:
  - url: https://api.zupy.com
    description: Production
security: []
tags:
  - name: Authentication
    description: OTP request and verification endpoints
  - name: Customers
    description: Customer management, points, history, and data operations
  - name: Loyalty Programs
    description: Loyalty program configuration and details
  - name: Rewards
    description: Loyalty reward catalog (definitions redeemed with points)
  - name: Companies
    description: Company information and loyalty configuration
  - name: Coupons
    description: >-
      Issued coupons (RewardRedemption) — both loyalty-reward redemptions and
      marketing claims
  - name: Wallet
    description: Apple Wallet pass generation and notifications
  - name: Webhooks
    description: Partner integration webhook endpoints
  - name: Webhook Management
    description: Configure and test outbound webhook delivery
paths:
  /api/v2/coupons/issued/:
    get:
      tags:
        - Coupons
      summary: List issued coupons
      description: >-
        List issued coupons (RewardRedemption instances) for the company — both
        loyalty-reward redemptions (origin_type=loyalty_reward, customer spent
        points) and marketing claims (origin_type=marketing, no points spent).
        Filter by status, customer_id, origin_type, reward_id, or coupon code.
      operationId: coupons_issued_list
      parameters:
        - name: cursor
          required: false
          in: query
          description: Pagination cursor value from previous response.
          schema:
            type: string
        - name: page_size
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - name: status
          required: false
          in: query
          description: 'Filter by status: active | used | expired | cancelled.'
          schema:
            type: string
        - name: customer_id
          required: false
          in: query
          description: Restrict to one customer (LoyaltyUser id).
          schema:
            type: string
        - name: origin_type
          required: false
          in: query
          description: 'Coupon provenance: loyalty_reward | marketing.'
          schema:
            type: string
            enum:
              - loyalty_reward
              - marketing
        - name: reward_id
          required: false
          in: query
          description: Restrict to coupons issued from one reward.
          schema:
            type: string
        - name: code
          required: false
          in: query
          description: Exact coupon_code lookup (case-insensitive).
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCouponInventoryList'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
      security:
        - apiKeyAuth: []
components:
  schemas:
    PaginatedCouponInventoryList:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CouponInventory'
        meta:
          type: object
          required:
            - cursor
            - has_next
            - count
          properties:
            cursor:
              type: string
              nullable: true
            has_next:
              type: boolean
            count:
              type: integer
              nullable: true
    Error:
      type: object
      description: RFC 7807 Problem Details error response.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
      required:
        - detail
        - instance
        - status
        - title
        - type
    CouponInventory:
      type: object
      description: >-
        Active coupon with usage tracking, expiration details, and associated
        reward information.
      properties:
        id:
          type: string
          readOnly: true
        coupon_code:
          type: string
          readOnly: true
        reward_name:
          type: string
          readOnly: true
        reward_id:
          type: string
          title: Recompensa
          readOnly: true
        customer_id:
          type: string
          readOnly: true
        customer_name:
          type: string
          readOnly: true
        status:
          allOf:
            - $ref: '#/components/schemas/CouponInventoryStatusEnum'
          readOnly: true
        status_display:
          type: string
          readOnly: true
        points_spent:
          type: integer
          readOnly: true
        redemption_date:
          type: string
          format: date-time
          readOnly: true
        valid_until:
          type: string
          format: date-time
          readOnly: true
        remaining_usages:
          type: integer
          readOnly: true
          description: Usos restantes deste cupom
        total_usages_allowed:
          type: integer
          readOnly: true
          description: Total allowed usages (snapshot from reward at redemption time)
        created_at:
          type: string
          format: date-time
          readOnly: true
        usage_date:
          type: string
          format: date-time
          nullable: true
          readOnly: true
          description: When the coupon was used/validated (null while active).
        origin_type:
          type: string
          readOnly: true
          description: >-
            loyalty_reward (redeemed with points) or marketing (claimed without
            points).
      required:
        - coupon_code
        - created_at
        - customer_id
        - customer_name
        - id
        - points_spent
        - redemption_date
        - remaining_usages
        - reward_id
        - reward_name
        - status
        - status_display
        - total_usages_allowed
        - valid_until
    CouponInventoryStatusEnum:
      enum:
        - active
        - used
        - expired
        - cancelled
        - pending
        - pending_blockchain
        - completed
        - failed
        - blockchain_error
      type: string
      description: |-
        * `active` - Ativo
        * `used` - Utilizado
        * `expired` - Expirado
        * `cancelled` - Cancelado
        * `pending` - Pending
        * `pending_blockchain` - Pending Blockchain
        * `completed` - Completed
        * `failed` - Failed
        * `blockchain_error` - Blockchain Error
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Per-company partner API key (zupy_pk_…). Validated by Zupy against the
        company integration key hash (Story 14.x); send it on every request as
        the X-API-Key header. Scoped read-write to the owning company's data.

````