List Tier Structure 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 activities (audit log) for a tier structure. Includes events for the tier structure itself and its nested tiers.

GET /v2/loyalties/tier-structures/{id}/activities

List Tier Structure Activities

cURL

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

200

{
  "data": [
    {
      "id": "<string>",
      "tier_structure_id": "<string>",
      "data": {},
      "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>"
        }
      }
    }
  ],
  "object": "list",
  "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 tier structure identifier.

Query Parameters

filters[junction] · enum<string>

Logical junction for combining filter conditions.

Available options: AND, OR

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

Filter by exact activity ID.

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

Exclude activities with this ID.

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

Filter by multiple activity IDs.

Maximum array length: 100

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

Exclude activities with these IDs.

Maximum array length: 100

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

Filter by exact activity type.

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

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

Exclude activities with this type.

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

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

Filter by multiple activity types.

Maximum array length: 10

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

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

Exclude activities with these types.

Maximum array length: 10

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

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

Filter for activities created before this date.

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

Filter for activities created after this date.

filters[created_at][conditions][$is] · integer

Filter for activities created exactly N days ago.

Required range: x >= 0

filters[created_at][conditions][$more_than] · integer

Filter for activities created more than N days ago.

Required range: x >= 0

filters[created_at][conditions][$less_than] · integer

Filter for activities created less than N days ago.

Required range: x >= 0

filters[created_at][conditions][$has_value] · string

Filter for records where created_at has a value.

filters[created_at][conditions][$is_unknown] · string

Filter for records where created_at is unknown.

limit · integer · default: 10

Maximum number of results to return (1-100).

Required range: 1 <= x <= 100

order · enum<string>[]

Sort order. Prefix with - for descending. Default: -created_at.

Available options: created_at, -created_at

cursor · string

Cursor for pagination. Obtained from a previous list response.

Response

200

application/json

List of tier structure activities

data · object[] · required

Show child attributes

object · enum<string> · required

Available options: list

cursor · object | null

Cursor for fetching the next page of results.

Show child attributes