---
title: "Search gift cards"
method: GET
path: "/gift_cards"
tags: ["Gift Cards"]
---

# Search gift cards

`GET /gift_cards`

## Request

- Base URL: `https://api.vrio.app`
- URL: `https://api.vrio.app/gift_cards`
- Auth: API key in header `X-Api-Key`

Search specific gift card information or obtain a comprehensive list of all existing gift card details.

## Query parameters

- `gift_card_id` string
- `gift_card_code` string
- `gift_card_active` boolean
- `limit` integer
- `offset` integer
- `sort_by` string
- `order` 'asc' | 'desc'

## Response `200`

OK

- object
  - `total` integer
  - `gift_cards` object[]
    - `gift_card_id` integer
    - `customer_id` integer, nullable
    - `gift_card_code` string
    - `gift_card_total` string
    - `gift_card_balance` string
    - `gift_card_active` boolean
    - `date_expire` string, date-time, nullable
    - `date_created` string, date-time
    - `created_by` integer
    - `date_modified` string, date-time
    - `modified_by` integer
    - `gift_card_notes` string, nullable

## Other responses

- `401`: Unauthorized response
- `403`: Forbidden response
- `413`: Payload Too Large response
- `500`: Error response

---

[API](https://skmtc.dev/vrio/apis/selling.md) - [All operations](https://skmtc.dev/vrio/apis/selling/llms.txt) - [OpenAPI document](https://skmtc.dev/vrio/apis/selling/revisions/83eca29c6745?raw)