List Card Definition Activities

⚠️ BETA endpoint

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.

Returns a paginated list of activities (audit log) for a specific card definition.

GET /v2/loyalties/card-definitions/{id}/activities

List Card Definition Activities

cURL

curl --request GET \
  --url https://api.voucherify.io/v2/loyalties/card-definitions/{id}/activities \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "object": "<string>",
  "data": [
    {
      "id": "<string>",
      "card_definition_id": "<string>",
      "data": {
        "card_definition": {
          "id": "<string>",
          "name": "<string>",
          "type": "INDIVIDUAL",
          "code_config": {
            "pattern": "<string>",
            "length": 123,
            "charset": "<string>",
            "prefix": "<string>",
            "postfix": "<string>"
          },
          "points_expiration": {
            "rolling_expiration": {
              "period": {
                "value": 2
              },
              "rounding": {
                "value": 6
              }
            },
            "calendar_expiration": {
              "expiration_dates": [
                {
                  "day": 16,
                  "month": 6
                }
              ]
            },
            "sliding_expiration": {
              "earning_activity": true,
              "spending_activity": true,
              "custom_activity": true,
              "custom_activity_types": [
                "<string>"
              ],
              "period": {
                "value": 2
              }
            }
          },
          "pending_points": {
            "period_based": {
              "period": {
                "value": 2
              }
            },
            "fixed_dates": {
              "dates": [
                {
                  "day": 16,
                  "month": 6
                }
              ]
            },
            "event_based": {
              "event_types": [
                "<string>"
              ],
              "cancel_period": {
                "value": 2
              }
            }
          },
          "earning_limits": {
            "global": {
              "limits": [
                {
                  "max": 2,
                  "period": {
                    "type": "CURRENT_PERIOD",
                    "current_period": {}
                  },
                  "points": {
                    "max": 1073741824
                  }
                }
              ]
            },
            "transactions": {
              "limits": [
                {
                  "max": 2,
                  "min_amount": 2
                }
              ]
            }
          },
          "spending_limits": {
            "global": {
              "limits": [
                {
                  "max": 2,
                  "period": {
                    "type": "CURRENT_PERIOD",
                    "current_period": {}
                  },
                  "points": {
                    "max": 1073741824
                  }
                }
              ]
            },
            "transactions": {
              "limits": [
                {
                  "type": "POINTS",
                  "max": 2
                }
              ]
            }
          },
          "refunds": {
            "spent_points": {
              "methods": [
                {
                  "type": "RETURN_POINTS"
                }
              ]
            },
            "earned_points": {
              "methods": [
                {}
              ]
            }
          },
          "balance_settings": {
            "allow_negative": true
          },
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "object": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "group_id": "<string>",
      "source": {
        "user": {
          "id": "<string>"
        },
        "api_key": {
          "name": "<string>",
          "app_id": "<string>",
          "client_app_id": "<string>"
        }
      }
    }
  ],
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<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

Path Parameters

id · string · required

Unique card definition identifier.

Query Parameters

filters[junction] · enum<string>

Available options: AND, OR

filters[id][conditions][$is] · string

Filter by exact activity ID.

filters[type][conditions][$is] · enum<string>

Filter by exact activity type.

Available options: vl.card_definition.created, vl.card_definition.updated, vl.card_definition.deleted, vl.card_definition.activated, vl.card_definition.deactivated, vl.card_definition.drafted, vl.card_definition.assigned, vl.card_definition.unassigned

filters[type][conditions][$in] · enum<string>[]

Filter by multiple activity types.

Available options: vl.card_definition.created, vl.card_definition.updated, vl.card_definition.deleted, vl.card_definition.activated, vl.card_definition.deactivated, vl.card_definition.drafted, vl.card_definition.assigned, vl.card_definition.unassigned

filters[created_at][conditions][$before] · string<date-time>

filters[created_at][conditions][$after] · string<date-time>

limit · integer · default: 10

Required range: 1 <= x <= 100

order · enum<string>[]

Sort order. Default: -created_at.

Available options: created_at, -created_at

cursor · string

Response

200

application/json

List of card definition activities

object · string · required

Allowed value: "list"

data · object[] · required

Show child attributes

cursor · object | null · required

Cursor for fetching the next page of results.

Show child attributes