List incentive 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, cursor-based list of activity entries for a specific incentive. Supports filtering by activity id, type, and created_at.

GET /v2/loyalties/incentives/{id}/activities

List incentive activities

cURL

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

200

{
  "data": [
    {
      "id": "<string>",
      "incentive_id": "<string>",
      "data": {
        "incentive": {
          "id": "linc_abc123def456",
          "name": "<string>",
          "stock": 1073741823,
          "created_at": "2023-11-07T05:31:56Z",
          "object": "<string>",
          "points": {
            "value": 4611686018427388000,
            "card_definition_id": "<string>"
          },
          "points_proportional": {
            "card_definition_id": "<string>",
            "order": {
              "amount": {
                "every": 4611686018427388000,
                "value": 4611686018427388000
              },
              "total_amount": {
                "every": 4611686018427388000,
                "value": 4611686018427388000
              },
              "metadata": {
                "every": 4611686018427388000,
                "value": 4611686018427388000,
                "property": "<string>"
              }
            },
            "customer": {
              "metadata": {
                "every": 4611686018427388000,
                "value": 4611686018427388000,
                "property": "<string>"
              }
            },
            "order_items": {
              "amount": {
                "every": 4611686018427388000,
                "value": 4611686018427388000,
                "applicable_to": [
                  {
                    "product": {
                      "id": "<string>"
                    },
                    "sku": {
                      "id": "<string>"
                    },
                    "products_collection": {
                      "id": "<string>"
                    }
                  }
                ]
              },
              "subtotal_amount": {
                "every": 4611686018427388000,
                "value": 4611686018427388000,
                "applicable_to": [
                  {
                    "product": {
                      "id": "<string>"
                    },
                    "sku": {
                      "id": "<string>"
                    },
                    "products_collection": {
                      "id": "<string>"
                    }
                  }
                ]
              },
              "quantity": {
                "every": 4611686018427388000,
                "value": 4611686018427388000,
                "applicable_to": [
                  {
                    "product": {
                      "id": "<string>"
                    },
                    "sku": {
                      "id": "<string>"
                    },
                    "products_collection": {
                      "id": "<string>"
                    }
                  }
                ]
              }
            }
          },
          "material": {
            "product": {
              "id": "<string>"
            },
            "sku": {
              "product_id": "<string>",
              "id": "<string>"
            }
          },
          "digital": {
            "discount_coupons": {
              "campaign_id": "<string>"
            },
            "gift_vouchers": {
              "campaign_id": "<string>",
              "balance": 4611686018427388000
            }
          },
          "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"
  },
  "object": "<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>"
}

{
  "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 incentive identifier (prefix: linc_).

Pattern: ^linc_[a-f0-9]+$

Example:

"linc_abc123def456"

Query Parameters

limit · integer · default: 10

Number of results per page (1–100, default 10).

Required range: 1 <= x <= 100

order · enum<string> enum<string>[]

Sort order for activities. Default: -created_at.

Available options: created_at, -created_at

cursor · string

Cursor token for the next page of activities (prefix: lcrsainc_).

Pattern: ^lcrsainc_[a-f0-9]+$

filters[junction] · enum<string>

Logical junction between filter conditions.

Available options: AND, OR

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

Pattern: ^lainc_[a-f0-9]+$

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

Pattern: ^lainc_[a-f0-9]+$

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

Required array length: 1 - 100 elements

Pattern: ^lainc_[a-f0-9]+$

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

Required array length: 1 - 100 elements

Pattern: ^lainc_[a-f0-9]+$

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

Available options: vl.incentive.created, vl.incentive.updated, vl.incentive.deleted, vl.incentive.activated, vl.incentive.drafted

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

Available options: vl.incentive.created, vl.incentive.updated, vl.incentive.deleted, vl.incentive.activated, vl.incentive.drafted

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

Required array length: 1 - 10 elements

Available options: vl.incentive.created, vl.incentive.updated, vl.incentive.deleted, vl.incentive.activated, vl.incentive.drafted

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

Required array length: 1 - 10 elements

Available options: vl.incentive.created, vl.incentive.updated, vl.incentive.deleted, vl.incentive.activated, vl.incentive.drafted

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

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

Response

200

application/json

A paginated list of incentive activities.

data · object[] · required

Show child attributes

cursor · object · required

Cursor for fetching the next page of results.

Show child attributes

object · string · required

Allowed value: "list"