v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Loyalties

List Loyalty Tiers

Retrieve a list of loyalty tiers which were added to the loyalty program.

get/v1/loyalties/{campaignId}/tiers

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'

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

Response

Returns a list of loyalty tier objects.

object'list' required

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

data_ref'data' required

Identifies the name of the attribute that contains the array of loyalty tier objects.

totalinteger required

Total number of loyalty tier objects.

Example response

{
  "data": [
    {
      "expiration": {
        "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
        "campaign_id": "camp_rRsfatlwN7unSeUIJDCYedal",
        "created_at": "2021-12-22T10:13:06.487Z",
        "updated_at": "2021-12-22T10:13:06.487Z"
      }
    }
  ]
}