List card templates

Returns a cursor-paginated list of card TEMPLATES in the calling organization.

What a card template is

A card template defines the loyalty program design + mechanics. Customers are enrolled onto a template via POST /v1/customers with card_id. Templates are the merchant’s product; individual customers get instances of them.

Filtering

• type - filter by card family (stamp, reward, discount, coupon, membership, gift_card, custom)
• status - draft, active, paused, archived. Without it you get every card except archived.
• external_id - your stable reference

See Pagination for cursor pattern.

GET /v1/cards

List card templates

cURL

curl --request GET \
  --url https://api.vexioncards.one/v1/cards \
  --header 'Authorization: Bearer <token>'

200

Page with 3 cards

{
  "object": "list",
  "data": [
    {
      "type": "stamp",
      "name": {
        "sk": "Coffee Card",
        "en": "Coffee card"
      },
      "description": {
        "sk": "Collect 10 stamps, get the 11th coffee free.",
        "en": "Collect 10 stamps, get the 11th coffee free."
      },
      "languages_supported": [
        "sk",
        "en"
      ],
      "default_language": "sk",
      "barcode_format": "QR",
      "external_id": "loyalty-coffee-stamp-2026",
      "design": {
        "text_color": "#FFFFFF",
        "bg_color": "#1F4E79",
        "logo_url": "https://stamp-icons.s3.eu-central-1.amazonaws.com/samples/logo-480x150.png?v=2026-09-17",
        "icon_url": "https://stamp-icons.s3.eu-central-1.amazonaws.com/coffee.png",
        "custom_background_image_url": null,
        "pattern_type": null,
        "show_logo_at_issuing_form": true,
        "show_background_color_at_issuing_form": true,
        "design_mode": "standard",
        "pattern_icon_urls": [],
        "strip_color": "#36C6FA"
      },
      "pass_fields": {
        "header": null,
        "front_left": {
          "label": {
            "sk": "Card",
            "en": "Card"
          },
          "value_template": "{{serial_number}}",
          "change_message": null
        },
        "front_right": null,
        "back": [
          {
            "key": "terms",
            "label": {
              "sk": "Terms",
              "en": "Terms"
            },
            "value_template": "Full terms at www.example.com",
            "change_message": null
          }
        ]
      },
      "mechanics": {
        "type": "stamp",
        "stamps_required": 10,
        "is_prepaid": false,
        "starting_stamps": 1,
        "reward_at_completion": "1x Free coffee (any size)",
        "stamp_count_images": null
      },
      "form_builder": {
        "enabled": true,
        "default_language": "sk",
        "fields": [
          {
            "id": "email",
            "type": "system",
            "system_key": "email",
            "required": true,
            "order": 0
          },
          {
            "id": "first_name",
            "type": "system",
            "system_key": "first_name",
            "required": true,
            "order": 1
          },
          {
            "id": "phone",
            "type": "system",
            "system_key": "phone",
            "required": false,
            "order": 2
          }
        ]
      },
      "referral": {
        "enabled": true,
        "referrer_bonus": 1,
        "referee_bonus": 1
      },
      "issuer": {
        "company_name": "Demo Bakery s.r.o.",
        "email": "[e-mail]",
        "phone": "[phone]"
      },
      "terms_of_use": {
        "enabled": true,
        "text": "Card je neprenosna a viazana na vasu identifikaciu. Sluzi na zber peciatok pri nakupe v prevadzkach Demo Bakery. Card je platna pocas trvania programu.",
        "full_url": "https://www.demobakery.sk/terms"
      },
      "issue_limit": null,
      "metadata": {},
      "id": "crd_sophcrprtvpmmnwxah2lomnkee",
      "object": "card",
      "issued_count": 42,
      "registration_url": "https://vexioncards.one/signup/?id=crd_sophcrprtvpmmnwxah2lomnkee",
      "status": "active",
      "created_at": 1782604800,
      "updated_at": 1782604800,
      "archived_at": null
    },
    {
      "type": "reward",
      "name": {
        "sk": "Cashback card",
        "en": "Cashback card"
      },
      "description": {
        "sk": "Za kazde 1€ ziskas 1 bod. 100 bodov = 1€ k pouzitiu pri dalsom nakupe.",
        "en": "Earn 1 point per €1 spent. 100 points = €1 to use at next purchase."
      },
      "languages_supported": [
        "sk",
        "en"
      ],
      "default_language": "sk",
      "barcode_format": "QR",
      "design": {
        "text_color": "#FFFFFF",
        "bg_color": "#1F4E79",
        "logo_url": "https://stamp-icons.s3.eu-central-1.amazonaws.com/samples/logo-480x150.png?v=2026-09-17",
        "icon_url": "https://stamp-icons.s3.eu-central-1.amazonaws.com/coffee.png",
        "custom_background_image_url": null,
        "pattern_type": null,
        "show_logo_at_issuing_form": true,
        "show_background_color_at_issuing_form": true,
        "design_mode": "standard",
        "pattern_icon_urls": [],
        "strip_color": "#36C6FA"
      },
      "pass_fields": {
        "header": {
          "label": {
            "sk": "Body",
            "en": "Points"
          },
          "value_template": "{{card.points}}",
          "change_message": null
        },
        "front_left": {
          "label": {
            "sk": "Cashback k dispozicii",
            "en": "Cashback available"
          },
          "value_template": "{{card.cashback_available | money}}",
          "change_message": null
        },
        "front_right": null,
        "back": []
      },
      "mechanics": {
        "type": "reward",
        "earn_mode": "flat",
        "earn_rate_per_unit": 1,
        "starting_points": 50,
        "redemption_mode": "cashback",
        "cashback_point_value": 0.01,
        "rewards": [],
        "tiers": [],
        "tier_demotion": {
          "enabled": false,
          "inactivity_days": 365
        }
      },
      "form_builder": {
        "enabled": true,
        "default_language": "sk",
        "fields": [
          {
            "id": "email",
            "type": "system",
            "system_key": "email",
            "required": true,
            "order": 0
          },
          {
            "id": "first_name",
            "type": "system",
            "system_key": "first_name",
            "required": true,
            "order": 1
          },
          {
            "id": "phone",
            "type": "system",
            "system_key": "phone",
            "required": false,
            "order": 2
          }
        ]
      },
      "referral": {
        "enabled": true,
        "referrer_bonus": 100,
        "referee_bonus": 50
      },
      "issuer": {
        "company_name": "Demo Coffee s.r.o.",
        "email": "[e-mail]",
        "phone": "[phone]"
      },
      "terms_of_use": {
        "enabled": true,
        "text": "Card je neprenosna a viazana na vasu identifikaciu. Sluzi na zber peciatok pri nakupe v prevadzkach Demo Bakery. Card je platna pocas trvania programu.",
        "full_url": "https://www.demobakery.sk/terms"
      },
      "metadata": {},
      "id": "crd_2hh2fekk5zazfyyvian4uhepyq",
      "object": "card",
      "issued_count": 42,
      "issue_limit": null,
      "registration_url": "https://vexioncards.one/signup/?id=crd_2hh2fekk5zazfyyvian4uhepyq",
      "status": "active",
      "external_id": null,
      "created_at": 1782604800,
      "updated_at": 1782604800,
      "archived_at": null
    },
    {
      "type": "gift_card",
      "name": {
        "sk": "Darceky poukaz",
        "en": "Gift card"
      },
      "description": {
        "sk": "Darujte zazitok. Plne uplatnitelny vo vsetkych prevadzkach.",
        "en": "Give an experience. Fully redeemable at all locations."
      },
      "languages_supported": [
        "sk",
        "en"
      ],
      "default_language": "sk",
      "barcode_format": "QR",
      "design": {
        "text_color": "#FFFFFF",
        "bg_color": "#1F4E79",
        "logo_url": "https://stamp-icons.s3.eu-central-1.amazonaws.com/samples/logo-480x150.png?v=2026-09-17",
        "icon_url": "https://stamp-icons.s3.eu-central-1.amazonaws.com/coffee.png",
        "custom_background_image_url": null,
        "pattern_type": null,
        "show_logo_at_issuing_form": true,
        "show_background_color_at_issuing_form": true,
        "design_mode": "standard",
        "pattern_icon_urls": [],
        "strip_color": "#36C6FA"
      },
      "pass_fields": {
        "header": {
          "label": {
            "sk": "Zostatok",
            "en": "Balance"
          },
          "value_template": "{{card.balance_minor | money}}",
          "change_message": null
        },
        "front_left": {
          "label": {
            "sk": "Platne do"
          },
          "value_template": "{{card.expires_at | date:'DD.MM.YYYY'}}",
          "change_message": null
        },
        "front_right": null,
        "back": []
      },
      "mechanics": {
        "type": "gift_card",
        "preset_values": [
          {
            "amount_minor": 2000,
            "bonus_minor": 0,
            "total_minor": 2000
          },
          {
            "amount_minor": 5000,
            "bonus_minor": 0,
            "total_minor": 5000
          },
          {
            "amount_minor": 10000,
            "bonus_minor": 0,
            "total_minor": 10000
          }
        ],
        "bonus_enabled": false,
        "expiration_months": 12,
        "is_employee_card": false,
        "allow_online_sales": false,
        "online_sale_location_id": null
      },
      "form_builder": {
        "enabled": true,
        "default_language": "sk",
        "fields": [
          {
            "id": "email",
            "type": "system",
            "system_key": "email",
            "required": true,
            "order": 0
          },
          {
            "id": "first_name",
            "type": "system",
            "system_key": "first_name",
            "required": true,
            "order": 1
          },
          {
            "id": "phone",
            "type": "system",
            "system_key": "phone",
            "required": false,
            "order": 2
          }
        ]
      },
      "referral": {
        "enabled": false,
        "referrer_bonus": 0,
        "referee_bonus": 0
      },
      "issuer": {
        "company_name": "Demo Bakery s.r.o.",
        "email": "[e-mail]",
        "phone": "[phone]"
      },
      "terms_of_use": {
        "enabled": true,
        "text": "Card je neprenosna a viazana na vasu identifikaciu. Sluzi na zber peciatok pri nakupe v prevadzkach Demo Bakery. Card je platna pocas trvania programu.",
        "full_url": "https://www.demobakery.sk/terms"
      },
      "metadata": {},
      "id": "crd_rvbt4ehupfalsp25g6fniwkmau",
      "object": "card",
      "issued_count": 42,
      "issue_limit": null,
      "registration_url": "https://vexioncards.one/signup/?id=crd_rvbt4ehupfalsp25g6fniwkmau",
      "status": "active",
      "external_id": null,
      "created_at": 1782604800,
      "updated_at": 1782604800,
      "archived_at": null
    }
  ],
  "has_more": true,
  "url": "/v1/cards"
}

Authorizations

Authorization · string · header · required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Headers

Accept-Language · enum<string> · default: sk

Preferred language for error messages and localized fields. One of sk, cs, en, de. Defaults to card's default_language.

Available options: sk, cs, en, de

Query Parameters

type · enum<string>

Filter by card family (stamp, reward, discount, coupon, membership, gift_card, custom).

Available options: stamp, reward, discount, coupon, membership, gift_card, custom

status · enum<string>

Lifecycle filter. Omitted returns every card EXCEPT archived (draft, active and paused), matching the dashboard catalog. Pass an explicit value to narrow to exactly that state; archived is the only way to see retired templates.

Available options: draft, active, paused, archived

external_id · string

Exact match on your stable reference for the card template. Returns every card template carrying this exact reference. Not unique, so more than one row is possible.

location_id · string

Cards enabled at this location (via Location.enabled_card_ids).

limit · integer · default: 25

Number of cards to return per page (1-100). Default 25.

Required range: 1 <= x <= 100

created[gte] · integer string<date-time>

Return cards created on or after this Unix timestamp.

created[lte] · integer string<date-time>

Return cards created on or before this Unix timestamp.

starting_after · string

Cursor for forward pagination - the id of the last card on the previous page. Numeric offset or page parameters are not supported; cursors are the only supported paging mechanism.

Pattern: ^crd_[A-Za-z0-9]+$

ending_before · string

Cursor for backward pagination - the id of the first card on the next page.

Pattern: ^crd_[A-Za-z0-9]+$

Response

200

application/json

Paginated card list.

Cursor-paginated list of Card templates returned by GET /v1/cards.

object · enum<string> · required

Always 'list'. Type discriminator.

Available options: list

data · object[] · required

Array of Card objects on this page. Up to limit items (default 25, max 100).

Show child attributes

has_more · boolean · required

True if more results exist beyond this page.

next_cursor · string | null

Cursor for the next page in the direction you are already paging, or null when this page ends the collection. has_more: true always comes with a non-null next_cursor.

Feed it back to the SAME parameter you used: starting_after when paging forward (the default), or ending_before when paging backward. Treat it as opaque and do not parse it.

You no longer need to take the last object's id yourself. That still works and is unchanged, but deriving the cursor from the page put the burden of knowing the sort direction on you, and it broke silently on any endpoint whose cursor is not the object id.

Example:

"cus_iofv5j4hn6bphinmmyat27tc5y"

url · string

Stable collection URL.