---
title: "GET /coupons/coupon/{couponName}/promo-codes"
method: GET
path: "/coupons/coupon/{couponName}/promo-codes"
tags: ["Promo Codes"]
---

# GET /coupons/coupon/{couponName}/promo-codes

`GET /coupons/coupon/{couponName}/promo-codes`

## Request

- The document declares no server URL.
- Auth: none required
- TypeScript: <https://skmtc.dev/appcharge/apis/grant-award/docs/coupons/coupon/:couponName/promo-codes/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a paginated list of up to 1,000 promo codes for a specific coupon.

## Query parameters

- `limit` integer
- `page` integer
- `sortDirection` 'asc' | 'desc'
- `isActive` boolean

## Response `200`

Promo codes retrieved successfully.

- ListPromoCodesResponse
  - `promoCodes` PromoCode[]: List of promo codes.
    - `name` string: Promo code name.
    - `active` boolean: Whether the promo code is active.
    - `maxRedemptions` integer: Maximum number of times this promo code can be redeemed.
    - `createdAt` string, date-time: Timestamp when the promo code was created.
    - `updatedAt` string, date-time: Timestamp when the promo code was last updated.
    - `redemptions` integer: Number of times this promo code has been redeemed.
  - `totalCount` integer: Total number of promo codes matching the query.
  - `totalPages` integer: Total number of pages matching the query.
  - `hasNextPage` boolean: Whether there is an additional page of results.
  - `page` integer: Current page number.
  - `limit` integer: Maximum number of promo codes per page.

## Other responses

- `404`: Coupon not found.

---

[API](https://skmtc.dev/appcharge/apis/grant-award.md) - [All operations](https://skmtc.dev/appcharge/apis/grant-award/llms.txt) - [OpenAPI document](https://skmtc.dev/appcharge/apis/grant-award/revisions/b4f6759240d5?raw)