Skip to main content
GET
Spree Admin SDK

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

Path Parameters

id
string
required

Gift card prefixed ID

Query Parameters

fields
string

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

Response

gift card found

id
string
required
code
string
required
status
string
required
currency
string
required
amount
string
required
amount_used
string
required
amount_authorized
string
required
amount_remaining
string
required
display_amount
string
required
display_amount_used
string
required
display_amount_remaining
string
required
expires_at
string | null
required
redeemed_at
string | null
required
expired
boolean
required
active
boolean
required
created_at
string
required
updated_at
string
required
customer_id
string | null
required
created_by_id
string | null
required
customer
object
created_by
object
gift_card_batch
object
orders
object[]