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

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

List program activities

cURL

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

200

{
  "data": [
    {
      "id": "<string>",
      "data": {
        "program": {
          "id": "<string>",
          "name": "<string>",
          "start_date": "2023-11-07T05:31:56Z",
          "end_date": "2023-11-07T05:31:56Z",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "object": "<string>"
        }
      },
      "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>"
        }
      },
      "program_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 program identifier

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

Query Parameters

filters[id][conditions] · object

Filter by activity id. Supports conditions $is, $is_not, $in, $not_in.

filters[type][conditions] · object

Filter by activity type. Supports conditions $is, $is_not, $in, $not_in. Valid values: vl.program.created, vl.program.updated, vl.program.deleted, vl.program.activated, vl.program.deactivated, vl.program.card_definition.assigned, vl.program.card_definition.unassigned, vl.program.earning_rule.assigned, vl.program.earning_rule.unassigned, vl.program.reward.assigned, vl.program.reward.unassigned, vl.program.tier_structure.assigned, vl.program.tier_structure.unassigned

filters[created_at][conditions] · object

Filter by activity creation date.

filters[junction] · enum<string>

Logical junction for combining activity filters

Available options: AND, OR

limit · integer · default: 10

Maximum number of results to return (1-100, default 10)

Required range: 1 <= x <= 100

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

Sort order for activities

Available options: created_at, -created_at

cursor · string

Cursor for pagination (from previous response)

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

Response

200

application/json

Paginated list of program activities

data · object[]

Show child attributes

cursor · object | null

Cursor for fetching the next page of results.

Show child attributes

object · string

Allowed value: "list"