v11

latestOpenAPI 3.1.12026-08-03174162.0 MB

Coupons

List coupons with cursor-based pagination

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

get/coupons

Query parameters

teamIdstring required

Unique identifier of the team whose coupons to retrieve

Example:tem_01jqpjksnsen9vprw95et60t2m

activeboolean

Optional filter to retrieve only active or inactive coupons

Example:true

querystring

Optional search query to filter coupons by name or description. When provided, search-backed pagination is used.

Example:Half Price

limitinteger

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

Example:20

cursorstring

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

Example:eyJpZCI6ImNwbl8wMWpwczVjZ3NmenMxa3NxYWV0NWhiYThhYyJ9

Response

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

{
  "coupons": [
    {
      "id": "cpn_01jps5cgsfzs1ksqaet5hba8ac",
      "couponId": "cpn_01jps5cgsfzs1ksqaet5hba8ac",
      "createdAt": "2026-08-03T06:13:52.214Z",
      "updatedAt": "2026-08-03T06:13:52.214Z",
      "name": "Half Price",
      "active": true,
      "kind": "PERCENT",
      "filter": "EVENTS",
      "currency": "AUD",
      "discount": 50,
      "limit": -1,
      "saleStartsAt": "2025-02-10T03:00:00"
    }
  ],
  "before": "eyJ2ZXJzaW9uIjoxLCJpbnRlbnQiOnsic291cmNlIjoiZGVtbyJ9LCJwb3MiOnsicHJpbWFyeUtleSI6InBybV8wMXM4NTNqIn19",
  "after": "eyJ2ZXJzaW9uIjoxLCJpbnRlbnQiOnsic291cmNlIjoiZGVtbyJ9LCJwb3MiOnsicHJpbWFyeUtleSI6InBybV8wMXM4NTNkIn19",
  "limit": 20
}