v36

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-017439390.7 KB

Get Customer Referrals

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.

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

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.

Query parameters

startAfterinteger

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

limitinteger

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

Response

Customer referrals retrieved successfully

countnumber

The total number of friends on the current page.

hasMoreboolean

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