Skip to main content
GET
/
api
/
v3
/
admin
/
gift_cards
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: giftCards } = await client.giftCards.list({
  page: 1,
  limit: 25,
  expand: ['customer', 'created_by'],
})
{
  "data": [
    {
      "id": "gc_UkLWZg9DAJ",
      "code": "CC7B2B4D3AB3008C",
      "status": "active",
      "currency": "USD",
      "amount": "50.0",
      "amount_used": "0.0",
      "amount_authorized": "0.0",
      "amount_remaining": "50.0",
      "display_amount": "$50.00",
      "display_amount_used": "$0.00",
      "display_amount_remaining": "$50.00",
      "expires_at": null,
      "redeemed_at": null,
      "expired": false,
      "active": true,
      "created_at": "2026-05-24T17:36:59.157Z",
      "updated_at": "2026-05-24T17:36:59.157Z",
      "customer_id": null,
      "created_by_id": null
    },
    {
      "id": "gc_gbHJdmfrXB",
      "code": "DDB3EA9E5861FC28",
      "status": "active",
      "currency": "USD",
      "amount": "25.0",
      "amount_used": "0.0",
      "amount_authorized": "0.0",
      "amount_remaining": "25.0",
      "display_amount": "$25.00",
      "display_amount_used": "$0.00",
      "display_amount_remaining": "$25.00",
      "expires_at": null,
      "redeemed_at": null,
      "expired": false,
      "active": true,
      "created_at": "2026-05-24T17:36:59.158Z",
      "updated_at": "2026-05-24T17:36:59.158Z",
      "customer_id": null,
      "created_by_id": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 2,
    "pages": 1,
    "from": 1,
    "to": 2,
    "in": 2,
    "previous": null,
    "next": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Bearer token for admin authentication

Query Parameters

page
integer

Page number

limit
integer

Number of records per page

q[code_cont]
string

Filter by gift card code (contains)

q[state_eq]
string

Filter by status (active, redeemed, partially_redeemed, canceled)

sort
string

Sort by field. Prefix with - for descending (e.g., -created_at).

fields
string

Comma-separated list of fields to include. id is always included.

Response

gift cards found

data
object[]
required
meta
object
required