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>'
{
  "count": 123,
  "totalPending": 123,
  "totalActive": 123
}
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

Path Parameters

customerId
string
required

Unique identifier for the customer

Response

200 - application/json

Customer referrals count found

count
number

The total number of friends referred by the customer

totalPending
number

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

totalActive
number

The total number of referred friends who have successfully completed the referral criteria