Skip to main content
GET
/
api
/
v4.0
/
integrations
/
configurations
/
referrals
Referrals Configurations
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/configurations/referrals \
  --header 'apikey: <api-key>'
{
  "referralMethod": "<string>",
  "eventName": "<string>",
  "eventMetaData": {
    "name": "<string>",
    "operator": "<string>",
    "value": "<string>"
  },
  "friendReward": {
    "score": 123,
    "point": 123,
    "coupon": {
      "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>"
      }
    }
  },
  "customerReward": {
    "score": 123,
    "point": 123,
    "coupon": {
      "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>"
      }
    },
    "extraReward": {
      "forEvery": 123,
      "score": 123,
      "point": 123,
      "coupon": {}
    }
  }
}

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

Referral settings retrieved successfully

​
referralMethod
string

This specifies who will receive the referral reward when a successful referral is made. Possible values: CustomerOnly (Only the customer making the referral will receive the reward. The referred friend will not receive any reward), CustomerAndFriend (Both the customer making the referral and the referred friend will receive rewards, encouraging mutual benefit).

​
eventName
string

This describes the event that will trigger the referral reward. Example: if the eventName is set to place_order, the referral reward will be granted when the referred friend completes an order after using the referral link. Other events can also be configured to trigger the reward, depending on your system's setup.

​
eventMetaData
object

Contains additional metadata about the event that triggers the referral.

​
friendReward
object

The reward details given to the referred friend as part of the referral program.

​
customerReward
object

The reward details given to the customer as part of the referral program.