younifyd
Menu

List Points Expiration

List Loyalty Card Point Expiration

GET/v1/loyalties/{campaignId}/members/{memberId}/points-expiration

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the List Points Expiration action (under Loyalties).
  3. Fill in the fields below, then reference the result from later steps as {{listPointsExpiration.response.data}}.

Request

Path parameters

campaignIdstringrequired

The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.

memberIdstringrequired

Loyalty card code.

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

pageinteger

Which page of results to return. The lowest value is `1`.

Response

Returns 200 with an object. Read it in later steps with {{listPointsExpiration.response.data.<field>}}.

objectstring

The type of the object represented by JSON. This object stores information about loyalty points expiration buckets in a dictionary.

One oflistDefault "list"

data_refstring

Identifies the name of the attribute that contains the array of loyalty points expiration bucket objects.

One ofdataDefault "data"

dataarray<object>

Contains array of loyalty points expiration buckets.

idstring

Unique identifier of the loyalty points bucket.

voucher_idstring

Unique identifier of the parent loyalty card.

campaign_idstring

Unique identifier of the parent campaign.

bucketobject1 fields

Defines the number of points stored in this loyalty point bucket.

statusstring

Loyalty point bucket status.

expires_atstring (date)

Date when the number of points defined in the bucket object are due to expire.

created_atstring (date-time)

Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format.

updated_atstring (date-time)

Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format.

objectstring

The type of the object represented by JSON. This object stores information about the loyalty point bucket.

One ofloyalty_points_bucket

totalinteger

Total number of point expiration buckets.

json
{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "string",
      "voucher_id": "string",
      "campaign_id": "string",
      "bucket": {
        "total_points": {}
      },
      "status": "string",
      "expires_at": "2025-01-01",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z",
      "object": "loyalty_points_bucket"
    }
  ],
  "total": 0
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.