List gift cards
giftup_list_gift_cardsRead-only
List gift cards with balance, status flags (canBeRedeemed, hasExpired, notYetValid, isVoided), title, recipient, expiry and the order they came from. Codes are MASKED (at least 6 characters stay hidden); to see one card in full (code and ledger) use giftup_get_gift_card with its code. Filter by state, creation/update time, order, SKU, recipient/purchaser email or payment transaction id. GET /gift-cards.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sku | No | Only gift cards with this private SKU. | |
| limit | No | Results per page, 1-100 (default 25). | |
| offset | No | Results to skip (default 0). Pass the previous reply's next_offset. | |
| status | No | Only gift cards in this state. | |
| order_id | No | Only gift cards of this order id. | |
| test_mode | No | Read the account's test data instead of live data (sends x-giftup-testmode: true). Default false. | |
| purchaser_email | No | Only gift cards bought by this purchaser email address. | |
| recipient_email | No | Only gift cards sent to this recipient email address. | |
| created_on_or_after | No | Only gift cards created on or after this time (UTC). | |
| updated_on_or_after | No | Only gift cards updated on or after this time (UTC). | |
| payment_transaction_id | No | Only gift cards whose payment-provider transaction id matches. |