List tier structure activities

curl --request GET \
  --url https://{cluster}.voucherify.io/v2/loyalties/tier-structures/{tierStructureId}/activities \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "type": "vl.tier_structure.created",
      "data": {
        "tier_structure": {
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "name": "<string>",
          "type": "POINT_BALANCE",
          "expiration": {
            "type": "NO_RETENTION",
            "fixed_duration": {
              "period": {
                "value": 123,
                "unit": "DAY"
              }
            },
            "calendar_expiration": {
              "calendar_dates": [
                {
                  "day": 16,
                  "month": 6
                }
              ]
            },
            "sliding_expiration": {
              "earning_activity": true,
              "spending_activity": true,
              "custom_activity": true,
              "custom_activity_types": [
                "<string>"
              ],
              "period": {
                "value": 123,
                "unit": "DAY"
              }
            }
          },
          "downgrade": {
            "type": "MULTI_LEVEL",
            "grace_period": {
              "value": 123,
              "unit": "DAY",
              "round_up": true
            }
          },
          "status": "DRAFT",
          "object": "tier_structure",
          "point_balance": {
            "card_definition_id": "<string>"
          },
          "point_earned": {
            "card_definition_id": "<string>",
            "period": {
              "value": 123,
              "unit": "DAY"
            },
            "type": "IMMEDIATELY"
          }
        },
        "tier": {
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "tier_structure_id": "<string>",
          "name": "<string>",
          "downgrade": {
            "type": "INHERIT"
          },
          "object": "tier",
          "qualification_rules": {
            "type": "POINTS",
            "points": {
              "min_value": 123,
              "max_value": 123
            },
            "segment": {
              "id": "<string>"
            }
          }
        },
        "program": {},
        "program_tier_structure": {}
      },
      "created_at": "2023-11-07T05:31:56Z",
      "tier_structure_id": "<string>",
      "group_id": "<string>",
      "source": {
        "channel": "USER_PORTAL",
        "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": "list"
}

{
  "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": 500,
  "key": "api_error",
  "message": "Something went wrong. Don't worry, your campaigns are still safe and the Voucherify Team has been notified. Check out our Help Center and forums for help, or head back to home."
}

List tier structure activities

Documentation in progress

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

Returns a cursor-paginated list of activities recorded for the tier structure (creation, updates, state transitions, assignments, and nested tier changes). The same field cannot be requested in both ascending and descending order at once. Default order is -created_at.

GET

loyalties

tier-structures

{tierStructureId}

activities

List tier structure activities

curl --request GET \
  --url https://{cluster}.voucherify.io/v2/loyalties/tier-structures/{tierStructureId}/activities \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "type": "vl.tier_structure.created",
      "data": {
        "tier_structure": {
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "name": "<string>",
          "type": "POINT_BALANCE",
          "expiration": {
            "type": "NO_RETENTION",
            "fixed_duration": {
              "period": {
                "value": 123,
                "unit": "DAY"
              }
            },
            "calendar_expiration": {
              "calendar_dates": [
                {
                  "day": 16,
                  "month": 6
                }
              ]
            },
            "sliding_expiration": {
              "earning_activity": true,
              "spending_activity": true,
              "custom_activity": true,
              "custom_activity_types": [
                "<string>"
              ],
              "period": {
                "value": 123,
                "unit": "DAY"
              }
            }
          },
          "downgrade": {
            "type": "MULTI_LEVEL",
            "grace_period": {
              "value": 123,
              "unit": "DAY",
              "round_up": true
            }
          },
          "status": "DRAFT",
          "object": "tier_structure",
          "point_balance": {
            "card_definition_id": "<string>"
          },
          "point_earned": {
            "card_definition_id": "<string>",
            "period": {
              "value": 123,
              "unit": "DAY"
            },
            "type": "IMMEDIATELY"
          }
        },
        "tier": {
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "tier_structure_id": "<string>",
          "name": "<string>",
          "downgrade": {
            "type": "INHERIT"
          },
          "object": "tier",
          "qualification_rules": {
            "type": "POINTS",
            "points": {
              "min_value": 123,
              "max_value": 123
            },
            "segment": {
              "id": "<string>"
            }
          }
        },
        "program": {},
        "program_tier_structure": {}
      },
      "created_at": "2023-11-07T05:31:56Z",
      "tier_structure_id": "<string>",
      "group_id": "<string>",
      "source": {
        "channel": "USER_PORTAL",
        "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": "list"
}

{
  "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": 500,
  "key": "api_error",
  "message": "Something went wrong. Don't worry, your campaigns are still safe and the Voucherify Team has been notified. Check out our Help Center and forums for help, or head back to home."
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Path Parameters

tierStructureId

string

required

Identifies the tier structure. Format lts_[a-f0-9]+.

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

Query Parameters

limit

default:10

Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.

Required range: 1 <= x <= 100

order

Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.

Available options:

created_at,

-created_at

cursor

string | null

Continues pagination. Pass the cursor.next value from a previous response. Format lcrsats_[a-f0-9]+. The cursor matches the filters and order of that response.

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

filters

Loyalties Tier Structures Activities List Request Query · object | null

Filters the results. Pass a deep object, for example filters[type][conditions][$is]=vl.tier_structure.created. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. Request query schema for GET /v2/loyalties/tier-structures/{tierStructureId}/activities.

Show child attributes

Response

Paginated list of tier structure activities.

Response body schema for GET /v2/loyalties/tier-structures/{tierStructureId}/activities.

data

object[]

required

Activities on the current page.

Show child attributes

cursor

object | null

required

Pagination cursor for fetching the next page, or null when there are no more results.

Show child attributes

object

string

required

Object type discriminator. Always list.

Allowed value: "list"

Introduction

Endpoints

Events

List tier structure activities

Authorizations

Path Parameters

Query Parameters

Response