Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Customers

List Customer Activities

❗️ Deprecated

This endpoint represents the deprecated version of the API responsible for listing customer activities and we do not recommend using it. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.

Retrieve customer activities.

get/v1/customers/{customerId}/activities

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.

order'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'type' | '-type' | 'code' | '-code' | 'campaign' | '-campaign' | 'category' | '-category'

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

starting_afterstring date-time
Example:2023-12-22T10:13:06.487Z

A cursor for pagination. starting_after is a date-time value that defines your place in the list based on created_at property from the activity object. For instance, if you make a list request and receive 100 objects, ending with an object created at 2020-05-24T13:43:09.024Z, your subsequent call can include starting_after=2020-05-24T13:43:09.024Z in order to fetch the next page of the list.

starting_after_idstring

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

campaign_type'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM' | 'DISCOUNT_COUPONS' | 'LOYALTY_PROGRAM'

Through this parameter you can control a type of campaign by which Voucherify will filter related customer's activity. API will return only records related to that given type. Allowed values: DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM

campaign_idstring
Example:camp_rRsfatlwN7unSeUIJDCYedal

By applying this parameter you request only events related to specific campaign identified by its ID.

product_idstring
Example:prod_3ttSkdxGuAfcv3

By applying this parameter you request only events related to specific product identified by its ID.

start_datestring date-time
Example:2023-12-22T10:13:06.487Z

Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

end_datestring date-time
Example:2023-12-22T10:13:06.487Z

Timestamp representing the date and time which results must end on. Represented in ISO 8601 format.

Response

Returns a dictionary with customer activities.

objectstring required

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

data_refstring required

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

totalinteger required

Total number of customer activities.