---
title: "Get Customer Referrals"
method: GET
path: "/api/v4.0/integrations/customers/{customerId}/referrals"
---

# Get Customer Referrals

`GET /api/v4.0/integrations/customers/{customerId}/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.

## Path parameters

- `customerId` string, required

## Query parameters

- `startAfter` integer
- `limit` integer

## Response `200`

Customer referrals retrieved successfully

- CustomerReferralsResponse
  - `referredFriends` object[] — A list of friends referred by the customer.
    - `customerId` string — Unique identifier for the referred friend.
    - `displayName` string — Display name of the referred friend.
    - `email` string — Email address of the referred friend.
    - `mobileNumber` string — Mobile number of the referred friend.
    - `joinDate` string — The date when the referred friend joined.
    - `status` 'Active' | 'Pending' — The current status of the referral: Active (The referral was successfully completed. The referred friend has completed the required action (e.g., placing an order), and the referral is counted for the customer), Pending (The referred friend has used the customer's referral link but has not yet completed the required action (e.g., signing up or making a purchase) for the referral to be considered complete).
  - `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.

---

[API](https://skmtc.net/gameballers/apis/gameball-api.md) · [All operations](https://skmtc.net/gameballers/apis/gameball-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gameballers/gameball-api/revisions/2e4a8bfe2291/schema)