Skip to main content
GET
/
api
/
v4.0
/
integrations
/
configurations
/
reward-campaigns
Campaigns Configurations
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/configurations/reward-campaigns \
  --header 'apikey: <api-key>'
[
  {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "isRepeatable": true,
    "maxAchievement": 123,
    "type": "<string>",
    "visibility": "<string>",
    "icon": "<string>",
    "availability": {
      "minTier": 123,
      "tags": [
        "<string>"
      ]
    },
    "redirectionButtonText": "<string>",
    "redirectionButtonLink": "<string>",
    "activation": {
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z"
    },
    "rewards": [
      {
        "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.

Query Parameters

​
customerId
string

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. If provided, the API filters and returns only the campaigns that can be achieved by this customer.

​
collectionId
string

Unique identifier for a product collection. If provided, the API returns the transactional campaigns applicable to the specified collection.

​
productSku
string

The SKU (Stock Keeping Unit) of a product. If provided, the API returns the transactional campaigns applicable to the specified product.

Response

200 - application/json

Campaigns retrieved successfully

​
id
number

Unique identifier for the reward campaign.

​
name
string

Name of the reward campaign.

​
description
string | null

A brief description of the reward campaign.

​
isRepeatable
boolean

Indicates whether the campaign can be earned multiple times. Example: If set to true, a customer can earn the campaign reward each time they meet the criteria, and if set to false, the campaign can only be earned once per customer.

​
maxAchievement
number

Specifies the maximum number of times the campaign can be earned if the value of isRepeatable is true. If the value is -1, it means the campaign can be earned indefinitely. Example: A value of 3 means the customer can earn the campaign reward up to three times before it is no longer available.

​
type
string

The type of the campaign. Possible values: SignUp (Reward is given when a user signs up), SocialMedia (Reward is linked to social media activity), ScheduledChallenge (A time-based challenge that gives rewards), Spin The Wheel (Rewards are given based on a spin-the-wheel game), EventBased (Reward is given based on specific customer events), HighScore (Reward is given based on achieving high scores in a campaign), Birthday (Reward is given for birthday-related activity).

​
visibility
string

The visibility status of the campaign. Possible values: AlwaysVisible (The campaign is always visible on the widget), NotVisible (The campaign is not visible to the customer on the widget), VisibleIfEarned (The campaign becomes visible once the customer earns it on the widget).

​
icon
string | null

The URL of the campaign's icon image. This icon visually represents the campaign and can be used in marketing materials or on the platform.

​
availability
object

Defines the criteria determining which customers are eligible to earn this reward campaign.

​
redirectionButtonText
string | null

The text displayed on the redirection button within the reward campaign page on the widget. Example: "Claim Your Reward" would prompt customers to take action.

​
redirectionButtonLink
string | null

The URL that the redirection button points to. When customers click the button, they will be redirected to this link. It should lead to a relevant page that provides more information or facilitates the reward campaign achievement. Example: "https://yourwebsite.com/rewards" directs customers to a page where they can view their rewards.

​
activation
object

Defines the activation criteria for the campaign, which may include specific start and end dates.

​
rewards
object[]

Details of the rewards that the customer will earn once achieving this reward campaign.