Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
referrals
/
count
Get Customer Referrals Count
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/referrals/count \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>'
{
  "count": 15,
  "totalPending": 5,
  "totalActive": 10
}
This API retrieves the total count of customers referred by a specified customer in Gameball, providing the number of completed and pending referrals.
Security: Requires apikey and secretkey headers.

Authorizations

​
apikey
string
header
required
​
secretkey
string
header
required

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.

Response

200 - application/json

Customer referrals count retrieved successfully

​
count
number

The total number of friends referred by the customer available in Gameball system.

​
totalPending
number

The total number of referred friends who have joined but not yet completed the referral criteria in the Gameball system.

​
totalActive
number

The total number of referred friends who have successfully completed the referral criteria in the Gameball system.