Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Card Definitions

List Card Definitions

<Warning>

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Returns a cursor-paginated list of card definitions.

Filtering is supported through the filters deep-object query parameter, e.g. filters[name][conditions][$is]=Standard%20Card. The same field cannot be requested in both ascending and descending order at the same time.

get/v2/loyalties/card-definitions

Query parameters

limitinteger

Maximum number of card definitions to return. Minimum: 1, maximum: 100. Defaults to 10 when omitted.

'-name' | 'name' | '-type' | 'type' | '-status' | 'status' | '-created_at' | 'created_at'
OR
string[]

Sort order. A single field or an array of fields. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both ascending and descending direction at the same time.

cursorstring

Pagination cursor returned by a previous call in cursor.next. Pattern: ^lcrscdef_[a-f0-9]+$.

{"stackTrail":"components:schemas:CardDefinitionListFilters:properties:junction","oasType":"schema","type":"unknown","description":"Logical junction between field filters. Defaults to `AND`."}

Filter conditions per field, e.g. filters[status][conditions][$is]=ACTIVE.

Response

A paginated list of card definitions.

objectstring required

Object type marker. Always list.