List 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": "C5BC700C4EF16A06",
      "status": "active",
      "currency": "USD",
      "amount": "50.00",
      "amount_used": "0.00",
      "amount_authorized": "0.00",
      "amount_remaining": "50.00",
      "expires_at": null,
      "redeemed_at": null,
      "expired": false,
      "active": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "customer_id": null,
      "created_by_id": null
    },
    {
      "id": "gc_gbHJdmfrXB",
      "code": "3BECEA5A776AD146",
      "status": "active",
      "currency": "USD",
      "amount": "25.00",
      "amount_used": "0.00",
      "amount_authorized": "0.00",
      "amount_remaining": "25.00",
      "expires_at": null,
      "redeemed_at": null,
      "expired": false,
      "active": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "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
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

GET

api

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": "C5BC700C4EF16A06",
      "status": "active",
      "currency": "USD",
      "amount": "50.00",
      "amount_used": "0.00",
      "amount_authorized": "0.00",
      "amount_remaining": "50.00",
      "expires_at": null,
      "redeemed_at": null,
      "expired": false,
      "active": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "customer_id": null,
      "created_by_id": null
    },
    {
      "id": "gc_gbHJdmfrXB",
      "code": "3BECEA5A776AD146",
      "status": "active",
      "currency": "USD",
      "amount": "25.00",
      "amount_used": "0.00",
      "amount_authorized": "0.00",
      "amount_remaining": "25.00",
      "expires_at": null,
      "redeemed_at": null,
      "expired": false,
      "active": true,
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "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
  }
}

{
  "error": {
    "code": "authentication_required",
    "message": "Authentication required"
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[code_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`created_by_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`currency`	One of the `CurrencyCode` codes	`eq` `not_eq` `in` `not_in` `null` `not_null`
`customer_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`expires_at`	Date	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`gift_card_batch_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`state`	One of `active`, `partially_redeemed`, `redeemed`, `canceled`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`status`	One of `active`, `partially_redeemed`, `redeemed`, `canceled`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Filters through associations

Prefix an associated record’s attribute with the association, as in q[batch_id_eq]. The same predicates apply.

Prefix	Attributes
`batch_`	`created_at`, `id`, `prefix`, `updated_at`
`customers_`	`accepts_email_marketing`, `created_at`, `email`, `first_name`, `id`, `last_name`, `phone`, `updated_at`
`customers_addresses_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customers_bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customers_customer_groups_`	`created_at`, `id`, `name`, `updated_at`
`customers_orders_`	`channel_id`, `completed_at`, `considered_risky`, `coupon_code`, `created_at`, `currency`, `customer_id`, `delivery_total`, `email`, `fulfillment_status`, `id`, `item_total`, `locale`, `market_id`, `number`, `order_group_id`, `payment_status`, `po_number`, `seller_id`, `status`, `total`, `total_quantity`, `updated_at`
`customers_ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`customers_spree_roles_`	`created_at`, `id`, `name`, `updated_at`
`customers_tags_`	`created_at`, `id`, `name`, `updated_at`
`orders_`	`channel_id`, `completed_at`, `considered_risky`, `coupon_code`, `created_at`, `currency`, `customer_id`, `delivery_total`, `email`, `fulfillment_status`, `id`, `item_total`, `locale`, `market_id`, `number`, `order_group_id`, `payment_status`, `po_number`, `seller_id`, `status`, `total`, `total_quantity`, `updated_at`
`orders_bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`orders_channel_`	`active`, `code`, `created_at`, `default`, `id`, `name`, `store_id`, `updated_at`
`orders_customer_`	`accepts_email_marketing`, `created_at`, `email`, `first_name`, `id`, `last_name`, `phone`, `updated_at`
`orders_fulfillments_`	`created_at`, `id`, `number`, `updated_at`
`orders_line_items_`	`additional_tax_total`, `adjustment_total`, `cost_price`, `created_at`, `discount_total`, `id`, `included_tax_total`, `non_taxable_adjustment_total`, `order_id`, `pre_tax_amount`, `price`, `quantity`, `tax_category_id`, `taxable_adjustment_total`, `updated_at`, `variant_id`
`orders_order_group_`	`created_at`, `currency`, `email`, `id`, `number`, `updated_at`
`orders_promotions_`	`code`, `created_at`, `expires_at`, `id`, `kind`, `name`, `path`, `promotion_category_id`, `starts_at`, `updated_at`
`orders_seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`orders_ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`orders_shipments_`	`created_at`, `id`, `number`, `updated_at`
`orders_store_`	`created_at`, `id`, `name`, `updated_at`
`orders_tags_`	`created_at`, `id`, `name`, `updated_at`
`users_`	`accepts_email_marketing`, `created_at`, `email`, `first_name`, `id`, `last_name`, `phone`, `updated_at`
`users_addresses_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`users_bill_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`users_customer_groups_`	`created_at`, `id`, `name`, `updated_at`
`users_orders_`	`channel_id`, `completed_at`, `considered_risky`, `coupon_code`, `created_at`, `currency`, `customer_id`, `delivery_total`, `email`, `fulfillment_status`, `id`, `item_total`, `locale`, `market_id`, `number`, `order_group_id`, `payment_status`, `po_number`, `seller_id`, `status`, `total`, `total_quantity`, `updated_at`
`users_ship_address_`	`address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`
`users_spree_roles_`	`created_at`, `id`, `name`, `updated_at`
`users_tags_`	`created_at`, `id`, `name`, `updated_at`

Sort by: code, created_at, created_by_id, currency, customer_id, expires_at, gift_card_batch_id, id, state, status, updated_at. Prefix a field with - to sort descending.

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

q[search]

string

Matches any of code (partial, case-insensitive).

q[active]

boolean

Set to true to apply active.

q[expired]

boolean

Set to true to apply expired.

q[partially_redeemed]

boolean

Set to true to apply partially_redeemed.

q[redeemed]

boolean

Set to true to apply redeemed.

page

integer

Page number

limit

integer

Number of records per page

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

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

Show child attributes

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters