Get Customer Referrals Count

Changed on

This API retrieves the total count of customers referred by a specified customer in Gameball, providing the number of completed and pending referrals.

get/api/v4.0/integrations/customers/{customerId}/referrals/count

Request

  • Base URL: https://api.gameball.co
  • URL: https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/referrals/count
  • Auth: API key in header apikey and API key in header secretkey

Path parameters

customerIdstring 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

Customer referrals count retrieved successfully

countnumber

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

totalPendingnumber

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

totalActivenumber

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

Changes

  • d43ca6bdac5aRevision changes
    • info

      the endpoint scheme security apiKey AND secretKey was added to the API

    • info

      the endpoint scheme security apiKey was removed from the API

    • info

      the endpoint scheme security secretKey was removed from the API

  • 788718651767Revision changes
    • info

      removed the non-success response with the status