Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Customers

List Customer Activity

Retrieves activity details of a given customer by customer's id or source_id.

get/v1/customers/{customerId}/activity

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'

Apply this filter to order the events according the date and time when it was created.

starting_after_idstring

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

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

Timestamp representing the date and time which results must begin 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.

campaign_idstring
Example:camp_rRsfatlwN7unSeUIJDCYedal

Requests only events related to specific campaign identified by its ID.

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

Filters related customer's activity for the selected campaign types. Allowed values: DISCOUNT_COUPONS, REFERRAL_PROGRAM, GIFT_VOUCHERS, PROMOTION, LOYALTY_PROGRAM.

category'ACTION' | 'EFFECT'

Filters activities for actions or effects. Allowed values: ACTION, EFFECT.

type'customer.confirmed' | 'customer.created' | 'customer.updated' | 'customer.deleted' | 'customer.referred' | 'customer.custom_event' | 'customer.segment.entered' | 'customer.segment.left' | 'customer.sms.sent' | 'customer.sms.recovered' | 'customer.sms.failed' | 'customer.email.sent' | 'customer.email.recovered' | 'customer.email.failed' | 'customer.activecampaign.sent' | 'customer.activecampaign.recovered' | 'customer.activecampaign.failed' | 'customer.braze.sent' | 'customer.braze.recovered' | 'customer.braze.failed' | 'customer.mailchimp.sent' | 'customer.mailchimp.recovered' | 'customer.mailchimp.failed' | 'customer.intercom.sent' | 'customer.intercom.recovered' | 'customer.intercom.failed' | 'customer.shopify.sent' | 'customer.shopify.recovered' | 'customer.shopify.failed' | 'customer.klaviyo.sent' | 'customer.klaviyo.recovered' | 'customer.klaviyo.failed' | 'customer.batch.sent' | 'customer.batch.recovered' | 'customer.batch.failed' | 'customer.rewarded' | 'customer.rewarded.loyalty_points' | 'customer.voucher.gift.balance_added' | 'customer.voucher.loyalty_card.points_added' | 'customer.voucher.loyalty_card.points_transferred' | 'customer.voucher.loyalty_card.points_expired' | 'customer.voucher.deleted' | 'customer.publication.succeeded' | 'customer.publication.failed' | 'customer.validation.succeeded' | 'customer.validation.failed' | 'customer.redemption.failed' | 'customer.redemption.succeeded' | 'customer.redemption.rollback.failed' | 'customer.redemption.rollback.succeeded' | 'customer.order.canceled' | 'customer.order.created' | 'customer.order.fulfilled' | 'customer.order.paid' | 'customer.order.processing' | 'customer.order.updated' | 'customer.reward_redemptions.created' | 'customer.reward_redemptions.pending' | 'customer.reward_redemptions.completed' | 'customer.reward_redemptions.rolledback' | 'customer.loyalty.updated' | 'customer.loyalty.tier.upgraded' | 'customer.loyalty.tier.downgraded' | 'customer.loyalty.tier.prolonged' | 'customer.loyalty.tier.expiration.changed' | 'customer.loyalty.tier.joined' | 'customer.loyalty.tier.left'

Event name of the customer event.

Response

Returns a dictionary with customer activities.

object'list' 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.

has_moreboolean required

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.