List gift cards | FluxStore Docs

GET/api/v1/gift-cards

List gift cards in the store. Paginated.

Gift card redemption codes are never exposed through the API. Responses include the ID, amount, balance, and status, but not the code.

Requires the GiftCards:View permission.

Query parameters

statusstring

Filter by gift card status.

Values:: activeredeemedexpired

skipinteger

Number of results to skip. Defaults to 0.

takeinteger

Page size, max 100. Defaults to 20.

Headers

X-Api-Keystringrequired

Your API key.

GET/api/v1/gift-cards


curl -H "X-Api-Key: flx_XXXX_XXXXXXXX" \
  https://api.fluxstore.net/api/v1/gift-cards

200OK


{
  "success": true,
  "data": {
    "items": [
      {
        "id": "gc_a1b2c3...",
        "amount": 25.00,
        "balance": 12.50,
        "applicationScope": "store",
        "status": "active",
        "expiresAt": "2027-01-01T00:00:00Z"
      }
    ],
    "total": 1,
    "skip": 0,
    "take": 20
  }
}