Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
tier-progress
Get Customer Tier Progress
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/tier-progress \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>'
{
  "current": {
    "order": 1,
    "name": "Basic",
    "minProgress": 0,
    "icon": "https://cdn.gameball.co/uploads/gb-library/levels-icons/level-a1.webp"
  },
  "next": {
    "order": 2,
    "name": "Gold",
    "minProgress": 190,
    "icon": "https://s3.us-east-2.amazonaws.com/gameball.stg.uploads/uploads/gb-library/levels-icons/level-a1.webp"
  },
  "progress": 50
}

Documentation Index

Fetch the complete documentation index at: https://docs.gameball.co/llms.txt

Use this file to discover all available pages before exploring further.

This API provides an overview of a customer’s current tier and progression within Gameball’s loyalty program. By retrieving the customer’s current tier, progress level, and next tier details, this endpoint offers a clear view of their advancement within the tier structure.
Security: Requires apikey and secretkey headers.

Authorizations

​
apikey
string
header
required
​
secretkey
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.

Path Parameters

​
customerId
string
required

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

Query Parameters

​
expand
string

Comma-separated expansions: tier,referrals

Response

200 - application/json

Customer tier progress retrieved successfully

​
current
object

The customer's current tier.

​
next
object

The next tier the customer can reach.

​
progress
number

The current progress of the customer toward the next tier, reflecting their activity and engagement within the program. This value is calculated based on the client's chosen tiering-up method, indicating how close the customer is to advancing to a higher tier. 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. Possible Values: Total amount spent, Total points earned, Friends referred, Orders completed, Score.