List gift cards

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.

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

Path parameters

locationIdstring required

Query parameters

limitinteger

Page size, 1 to 200. Default 50.

afterstring

The nextCursor of the previous page.

customerIdstring

Only this customer's cards.

externalReferencestring

Only cards with this external reference.

codestring

Only the card with this code.

Response

nextCursorstring

Pass as after to fetch the next page. Absent on the last page.

Example response

{
  "data": [
    {
      "accountingType": "single_purpose",
      "beneficiary": "Anna Andersson",
      "code": "K7QX9M2D",
      "createdAt": "2026-11-17T09:14:03Z",
      "currency": "SEK",
      "customerId": "per_2QCtWVSaVO7yCRYBj1zsbA",
      "description": "Presentkort",
      "externalReference": "shopify-5512340001-1",
      "id": "gft_7Qm2xN0cT1kPz4Wb9LrEaD",
      "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
      "merchantId": "mer_2Rk8sVh3Yq6Nf1Tz0JwUcM",
      "note": "Web shop order 10042",
      "remainingValue": "500.00",
      "soldDate": "2026-11-17",
      "status": "active",
      "updatedAt": "2026-10-12T09:24:31.512Z",
      "validUntil": "2027-11-17",
      "value": "500.00",
      "vatPercent": "25"
    }
  ],
  "nextCursor": "gft_7Qm2xN0cT1kPz4Wb9LrEaD"
}

Changes

No recorded changes to this operation across all 1 revision of this API.