Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Coupon Codes

List coupon codes with cursor-based pagination

Returns coupon code data with cursor-based pagination and optional full-text search via the query parameter.

get/coupon-codes

Query parameters

couponIdstring

Optional filter to retrieve coupon codes for a specific coupon

Example:cpn_01jps5cgsfzs1ksqaet5hba8ac
teamIdstring

Optional filter to retrieve coupon codes created by a specific team

Example:tem_01jqpjksnsen9vprw95et60t2m
activeboolean

Optional filter to retrieve only active or inactive coupon codes

Example:true
querystring

Optional search query to filter coupon codes by name. When provided, search-backed pagination is used.

Example:SUMMER
limitinteger

Maximum number of coupon codes to return per request (1-100, default: 20)

Example:20
cursorstring

Pagination cursor returned by a previous request. Omit on the first request.

Example:eyJpZCI6ImNwY18wMWpwczVjZ3NmenR3N2h4Y3ZyMndmdGsyIn0

Response

OK

beforestring nullable

Cursor for navigating backward in the result set. Omitted when there are no prior results.

afterstring nullable

Cursor for navigating forward in the result set. Omitted when there are no subsequent results.

limitnumber required

Maximum number of items to return in each result set

Example response

{
  "codes": [
    {
      "id": "cod_01jps5cgsfzftw7hxcvr2wftk2",
      "createdAt": "2026-08-03T06:13:52.214Z",
      "updatedAt": "2026-08-03T06:13:52.214Z",
      "name": "TEST50",
      "active": true,
      "couponId": "cpn_01jps5cgsfzs1ksqaet5hba8ac"
    }
  ],
  "before": "eyJ2ZXJzaW9uIjoxLCJpbnRlbnQiOnsic291cmNlIjoiZGVtbyJ9LCJwb3MiOnsicHJpbWFyeUtleSI6InBybV8wMXM4NTNqIn19",
  "after": "eyJ2ZXJzaW9uIjoxLCJpbnRlbnQiOnsic291cmNlIjoiZGVtbyJ9LCJwb3MiOnsicHJpbWFyeUtleSI6InBybV8wMXM4NTNkIn19",
  "limit": 20
}