---
title: "ListGiftCards"
method: GET
path: "/v2/gift-cards"
tags: ["GiftCards"]
---

# ListGiftCards

`GET /v2/gift-cards`

Lists all gift cards. You can specify optional filters to retrieve 
a subset of the gift cards.

## Query parameters

- `type` string
- `state` string
- `limit` integer
- `cursor` string
- `customer_id` string

## Response `200`

Success

- ListGiftCardsResponse — A response that contains one or more `GiftCard`. The response might contain a set of `Error` objects if the request resulted in errors.
  - `cursor` string — When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of gift cards. If empty, this is the final response.
  - `errors` Error[] — Any errors that occurred during the request.
    - `category` string, required — The high-level category for the error.
    - `code` string, required — The specific code of the error.
    - `detail` string — A human-readable description of the error for debugging purposes.
    - `field` string — The name of the field provided in the original request (if any) that the error pertains to.
  - `gift_cards` GiftCard[] — Gift cards retrieved.
    - `balance_money` Money — Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
      - `amount` integer — The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents. Monetary amounts can be positive or negative. See the specific field description to determine the meaning of the sign in a particular case.
      - `currency` string — The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](https://developer.squareup.com/reference/square_2021-08-18/enums/Currency) for possible values.
    - `created_at` string — The timestamp when the gift card was created, in RFC 3339 format. In the case of a digital gift card, it is the time when you create a card (using the Square Point of Sale application, Seller Dashboard, or Gift Cards API). In the case of a plastic gift card, it is the time when Square associates the card with the seller at the time of activation.
    - `customer_ids` string[] — The IDs of the customers to whom this gift card is linked.
    - `gan` string — The gift card account number.
    - `gan_source` unknown
    - `id` string — The Square-assigned ID of the gift card.
    - `state` unknown
    - `type` unknown, required

---

[API](https://skmtc.net/square/apis/squareup.md) · [All operations](https://skmtc.net/square/apis/squareup/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/square/squareup/revisions/8d95e3639487/schema)