Skip to main content
GET
/
v2
/
loyalties
/
card-definitions
List Card Definitions
curl --request GET \
  --url {protocol}://{host}/v2/loyalties/card-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "INDIVIDUAL",
      "code_config": {
        "pattern": "<string>",
        "length": 123,
        "charset": "<string>",
        "prefix": "<string>",
        "postfix": "<string>"
      },
      "points_expiration": {
        "rolling_expiration": {
          "period": {
            "value": 123
          },
          "rounding": {
            "value": 6
          }
        },
        "calendar_expiration": {
          "expiration_dates": [
            {
              "day": 16,
              "month": 6
            }
          ]
        },
        "sliding_expiration": {
          "custom_activity_types": [
            "<string>"
          ],
          "period": {
            "value": 123
          },
          "earning_activity": true,
          "spending_activity": true,
          "custom_activity": true
        }
      },
      "pending_points": {
        "period_based": {
          "period": {
            "value": 123
          }
        },
        "fixed_dates": {
          "dates": [
            {
              "day": 16,
              "month": 6
            }
          ]
        },
        "event_based": {
          "event_types": [
            "<string>"
          ],
          "cancel_period": {
            "value": 123
          }
        }
      },
      "earning_limits": {
        "global": {
          "limits": [
            {
              "type": "<string>",
              "max": 123
            }
          ]
        },
        "transactions": {
          "limits": [
            {
              "type": "<string>",
              "max": 123
            }
          ]
        }
      },
      "spending_limits": {
        "global": {
          "limits": [
            {
              "type": "<string>",
              "max": 123
            }
          ]
        },
        "transactions": {
          "limits": [
            {
              "type": "<string>",
              "max": 123
            }
          ]
        }
      },
      "refunds": {
        "spent_points": {
          "methods": [
            {
              "type": "<string>"
            }
          ]
        },
        "earned_points": {
          "methods": [
            {
              "type": "<string>"
            }
          ]
        }
      },
      "balance_settings": {
        "allow_negative": true
      },
      "pay_with_points": {
        "exchange_ratio": {
          "formula": "<string>"
        }
      },
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "object": "<string>"
    }
  ],
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "object": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id
string
header
required
X-App-Token
string
header
required

Query Parameters

limit
integer
default:10

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

Required range: 1 <= x <= 100
order

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.

Available options:
-name,
name,
-type,
type,
-status,
status,
-created_at,
created_at
cursor
string

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

Pattern: ^lcrscdef_[a-f0-9]+$
filters
object

Filter conditions per field, e.g. filters[status][conditions][$is]=ACTIVE. Filters for the card definitions list endpoint. Each field accepts a conditions object; provided conditions must be valid for the field type.

Response

A paginated list of card definitions.

Cursor-paginated list of card definitions.

data
object[]
required

The card definitions in the current page.

cursor
object | null
required

Pagination cursor. Null when there are no more results.

object
string
required

Object type marker. Always list.

Allowed value: "list"
Last modified on July 10, 2026