Skip to main content
GET
/
api
/
v4.0
/
integrations
/
configurations
/
tiers
Tiers Configurations
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/configurations/tiers \
  --header 'apikey: <api-key>'
[
  {
    "name": "<string>",
    "minProgress": 123,
    "order": 123,
    "icon": "<string>",
    "benefits": [
      {
        "type": "<string>",
        "description": "<string>",
        "hyperLink": "<string>",
        "rankReward": 123,
        "walletReward": 123,
        "walletRewardFactor": 123,
        "couponReward": {
          "couponType": "<string>",
          "discountValue": 123,
          "product": {
            "productId": "<string>",
            "productName": "<string>",
            "variantId": "<string>",
            "variantName": "<string>",
            "productDisplayName": "<string>"
          },
          "collections": [
            {
              "collectionId": "<string>",
              "collectionName": "<string>"
            }
          ],
          "group": {
            "handle": "<string>",
            "title": "<string>",
            "url": "<string>",
            "iconPath": "<string>",
            "description": "<string>",
            "maxPerCustomer": 123,
            "startDate": "2023-11-07T05:31:56Z",
            "expiryDate": "2023-11-07T05:31:56Z",
            "isAvailable": true,
            "isActive": true
          },
          "options": {
            "name": "<string>",
            "expiryAfter": 123,
            "usageLimit": 123,
            "capping": 123,
            "minOrderValue": 123,
            "codePrefix": "<string>",
            "redeemInstructions": "<string>"
          }
        }
      }
    ]
  }
]

Authorizations

​
apikey
string
header
required

Headers

​
lang
string

If the lang header is provided, the response will be returned in the specified language (e.g., en for English, fr for French). If this header is not included, the system will use the default language.

Response

200 - application/json

VIP tiers retrieved successfully

​
name
string

The name of the tier.

​
minProgress
number

The minimum amount of progress a customer needs to reach this tier in the program. This represents the threshold that must be met for a customer to reach this tier. Example: if the minProgress is set to 2000, the customer must accumulate 2000 points, referrals, or completed orders (depending on the tiering method) to reach this tier. Possible Values: Total amount spent, Total points earned, Friends referred, Orders completed, Score. Example: If the progress value is 1500 and the tiering-up method is total points earned, this means the customer has earned a total of 1500 points toward their next tier.

​
order
number

This represents the numerical order of a tier. Higher numbers indicate higher tiers.

​
icon
string

The URL for the icon associated with the tier. You can utilize this icon URL to display tier badges or indicators in your own custom interface, such as on customer profiles.

​
benefits
object[]

It contains a list of rewards associated with the tier, each offering specific advantages to the customer. This array includes various types of benefits.