v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Loyalties

List Loyalty Tier Earning Rules

Retrieve available earning rules for a given tier and the calculation method for earning points.

get/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules

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 a list of earning rules for a given tier. The object for each earning rule also contains information about how the points are calculated; this includes mapping. If a specific multiplier was used to calculate points for a given tier, then the loyalty.points parameter will account for this calculation.

object'list' required

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

data_ref'data' required

Identifies the name of the attribute that contains the array of earning rule objects.

totalinteger required

Total number of earning rule objects.