---
title: "List gift cards"
method: GET
path: "/v1/locations/{locationId}/gift-cards"
tags: ["Gift cards"]
---

# List gift cards

`GET /v1/locations/{locationId}/gift-cards`

## Request

- Base URL: `https://api.cliento.com`
- URL: `https://api.cliento.com/v1/locations/{locationId}/gift-cards`
- Auth: HTTP bearer

The location's gift cards, newest first, one page at a time. To read them all, repeat the call with `after` set to the `nextCursor` of the previous page until a page has none.

## Path parameters

- `locationId` string, required

## Query parameters

- `limit` integer
- `after` string
- `customerId` string
- `externalReference` string
- `code` string

## Response `200`

OK

- GiftCardList
  - `data` GiftCard[], required
    - `accountingType` string: How VAT is handled. `single_purpose`: VAT is charged when the card is sold. `multi_purpose`: VAT is charged when the card is redeemed.
    - `beneficiary` string: Who the card is for, as free text.
    - `code` string, required: What the holder shows or types when paying.
    - `createdAt` string, date-time, required
    - `currency` string, required: ISO 4217 currency code.
    - `customerId` string: The person, company or vehicle the card is linked to, when it is linked to one. The id's prefix says which.
    - `description` string
    - `externalReference` string: Your own id for the card, as sent when it was imported.
    - `id` string, required: Gift card id.
    - `locationId` string, required
    - `merchantId` string: The merchant the card belongs to.
    - `note` string: A note for staff, shown on the card in Cliento.
    - `remainingValue` string, required: What is left to spend.
    - `soldDate` string, date: The day the card was sold, in the location's time zone.
    - `status` string, required: `active`: usable, nothing spent. `partially_redeemed`: usable, some spent. `redeemed`: nothing left. `expired`: past `validUntil`. `void`: cancelled. More values may be added.
    - `updatedAt` string, date-time, required: When it last changed, in UTC.
    - `validUntil` string, date: The last day the card can be used.
    - `value` string, required: The card's full value.
    - `vatPercent` string: The VAT rate of a single-purpose card.
  - `nextCursor` string: Pass as `after` to fetch the next page. Absent on the last page.

## Other responses

- `default`: Any failure. See the Errors section.

---

[API](https://skmtc.dev/cliento/apis/cliento-api.md) · [All operations](https://skmtc.dev/cliento/apis/cliento-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cliento/apis/cliento-api/revisions/29ca811bc061?raw)