Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
referrals
Get Customer Referrals
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/referrals \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>'
{
  "referredFriends": [
    {
      "customerId": "<string>",
      "displayName": "<string>",
      "email": "<string>",
      "mobileNumber": "<string>",
      "joinDate": "<string>",
      "status": "Active"
    }
  ],
  "count": 123,
  "hasMore": true
}
This API retrieves a list of customers referred by a specified customer in Gameball, including each referral’s join date and current status within the referral program.
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.

Query Parameters

​
startAfter
integer<int64>
default:0

Specifies the page will start after which Gameball customer id. Defaults to 0.

​
limit
integer
default:50

Specifies the number of friends to return per page. Defaults to 50, with a maximum limit of 200 transactions per page.

Required range: x <= 200

Response

200 - application/json

Customer referrals retrieved successfully

​
referredFriends
object[]

A list of friends referred by the customer.

​
count
number

The total number of friends on the current page.

​
hasMore
boolean

Indicating whether there are additional friends to be fetched beyond the current page.