Skip to Content
FluxStore is currently invite-only. Some sections of this documentation are still being written and expanded.
APIManagement APIGift CardsGet a gift card
GET/api/v1/gift-cards/{id}

Retrieve a single gift card by its ID.

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.

Path parameters

idstring· uuidrequired
The gift card ID.

Gift card object

idstring· uuidrequired
The gift card ID.
amountnumberrequired
Initial value of the card.
balancenumberrequired
Remaining balance.
applicationScopestringrequired
What the gift card can be redeemed against.
Values:
storecategorypackage
categoryIdsstring[]· uuid
Categories the card can be redeemed against (when scope is category).
packageIdsstring[]· uuid
Packages the card can be redeemed against (when scope is package).
recipientNamestring
Recipient name.
recipientEmailstring· email
Recipient email.
messagestring
Personalized message.
expiresAtstring· date-time
Expiry timestamp, or null if no expiry.
statusstringrequired
Current status of the card.
Values:
activeredeemedexpired
createdAtstring· date-timerequired
Creation timestamp.
updatedAtstring· date-timerequired
Last update timestamp.
List gift cardsCreate a gift card