List Member Activity

GET/v1/loyalties/members/{memberId}/activity

Use it in a workflow

Add a step and choose the Voucherify connector.
Pick the List Member Activity action (under Loyalties).
Fill in the fields below, then reference the result from later steps as {{listMemberActivity.response.data}}.

Request

Path parameters

memberIdstringrequired

Unique loyalty card assigned to a particular customer.

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.

orderstring

Apply this filter to order the events according the date and time when it was created. The dash `-` preceding a sorting option means sorting in a descending order.

One ofcreated_at-created_at

starting_after_idstring

A cursor for pagination. It retrieves the events starting after an event with the given ID.

Response

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

objectstring

The type of the object represented by JSON. This object stores information about member activities in a dictionary.

One oflistDefault "list"

data_refstring

Identifies the name of the attribute that contains the array of member activity objects.

Default "data"

dataarray<object>

Array of member activity objects.

idstring

Unique event ID, assigned by Voucherify.

typestring

Event type.

One ofcustomer.loyalty.tier.upgradedcustomer.loyalty.tier.downgradedcustomer.loyalty.tier.prolongedcustomer.loyalty.tier.expiration.changedcustomer.loyalty.tier.joinedcustomer.loyalty.tier.leftcustomer.publication.succeededcustomer.publication.failedcustomer.redemption.failedcustomer.redemption.succceededcustomer.redemption.rollback.failedcustomer.redemption.rollback.succceededcustomer.rewardedcustomer.rewarded.loyalty_pointscustomer.reward_redemptions.createdcustomer.reward_redemptions.pendingcustomer.reward_redemptions.completedcustomer.reward_redemptions.rolledbackcustomer.voucher.deletedcustomer.voucher.loyalty_card.pending_points.activatedcustomer.voucher.loyalty_card.pending_points.addedcustomer.voucher.loyalty_card.pending_points.canceledcustomer.voucher.loyalty_card.pending_points.updatedcustomer.voucher.loyalty_card.points_addedcustomer.voucher.loyalty_card.points_transferredcustomer.voucher.loyalty_card.points_expired

dataobject2 fields

Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type.

created_atstring (date-time)

Timestamp representing the date and time when the member activity occurred in ISO 8601 format.

group_idstring

Unique identifier of the request that caused the event.

has_moreboolean

As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request with a `starting_after_id` query or a different limit to get more records returned in the results.

more_starting_afterstring

Returns an ID that can be used to return another page of results. Use the event ID in the `starting_after_id` query parameter to display another page of the results starting after the event with that ID.

json

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "evcus_0c150c51730c6b60b1",
      "type": "customer.loyalty.tier.upgraded",
      "data": {
        "data": null,
        "event_source": {
          "type": null,
          "description": null
        }
      },
      "created_at": "2022-08-30T09:14:07.660Z",
      "group_id": "w-0e30613abc1f044513"
    }
  ],
  "has_more": false,
  "more_starting_after": "string"
}

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

Was this page helpful?