GET /GiftCards - NowBookIt API

Search and retrieve a paginated list of gift cards. Use filters to narrow results by SKU, issue date, or status flags.

X-API-KEY

string

required

Your API key

Sku

string

Filter by SKU

IssueDateUtcStart

string

Filter by issue date (start). Format: yyyy-MM-ddTHH:mm:ss.fffZ

IssueDateUtcEnd

string

Filter by issue date (end). Format: yyyy-MM-ddTHH:mm:ss.fffZ

IncludeCancelled

boolean

Include cancelled cards. Default: false

IncludeRedeemed

boolean

Include fully redeemed cards. Default: false

IncludeExpired

boolean

Include expired cards. Default: false

Limit

integer

Number of records to return

StartIndex

integer

Zero-based offset for pagination

curl --location '[BASE_URL]/GiftCards?Limit=20&StartIndex=0&IncludeCancelled=false' \
--header 'X-API-KEY: your_api_key_here'

Response is a paginated result with from, to, length, and items (array of GiftCard). GiftCard fields

Field	Type	Description
`cardNumber`	string	Format: `XXXXX-XXXXXXXX-XXXX`
`issuedDate`	datetime	UTC issue date
`expiryDate`	datetime	UTC expiry date
`amount`	number	Original balance
`remainingAmount`	number	Remaining balance after redemptions
`status`	string	`Active`, `Cancelled`, `Redeemed`, `AwaitingPayment`, `PendingPostage`, `Expired`
`paymentType`	string	`InHouse`, `Online`, `Complimentary`
`cardFormat`	string	`EGiftCard`, `PhysicalCard`, `ExperienceGiftCard`, `LSEGiftCard`, `LSExperienceGiftCard`
`experienceCardName`	string	Experience cards only
`experienceCardDetails`	string	Experience cards only
`purchaserFirstName`	string	Purchaser first name
`purchaserLastName`	string	Purchaser last name
`purchaserEmail`	string	Purchaser email
`recipientFirstName`	string	Recipient first name
`recipientLastName`	string	Recipient last name
`recipientEmail`	string	Recipient email

Example 200 Response

{
  "from": 0,
  "to": 1,
  "length": 1,
  "items": [
    {
      "cardNumber": "ABCDE-12345678-WXYZ",
      "issuedDate": "2024-01-10T09:00:00Z",
      "expiryDate": "2025-01-10T09:00:00Z",
      "amount": 100.00,
      "remainingAmount": 75.00,
      "status": "Active",
      "paymentType": "Online",
      "cardFormat": "EGiftCard",
      "purchaserFirstName": "John",
      "purchaserLastName": "Doe",
      "purchaserEmail": "john.doe@example.com",
      "recipientFirstName": "Jane",
      "recipientLastName": "Doe",
      "recipientEmail": "jane.doe@example.com"
    }
  ]
}

Status	Description
`200`	Gift cards returned
`400`	`loggedInAppId`
`400`	`No Venue Subscribed to your App.`
`401`	X-API-KEY missing or invalid
`429`	Rate limit exceeded