> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gameball.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Customer Referrals

> Retrieve a list of customers referred by a specified customer in Gameball, including each referral's join date and current status.

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.

<Info>
  **Security**: Requires **apikey** and **secretkey** headers.
</Info>


## OpenAPI

````yaml GET /api/v4.0/integrations/customers/{customerId}/referrals
openapi: 3.1.0
info:
  title: Gameball API
  description: >-
    Gameball REST API v4.0 - Complete API reference for integrating loyalty,
    gamification, and customer engagement features
  version: 4.0.0
servers:
  - url: https://api.gameball.co
security:
  - bearerAuth: []
paths:
  /api/v4.0/integrations/customers/{customerId}/referrals:
    get:
      summary: Get Customer Referrals
      description: >-
        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.
      operationId: getCustomerReferrals
      parameters:
        - name: customerId
          in: path
          required: true
          description: >-
            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.
          schema:
            type: string
        - name: startAfter
          in: query
          required: false
          schema:
            type: integer
            format: int64
            default: 0
          description: >-
            Specifies the page will start after which Gameball customer id.
            Defaults to 0.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
            maximum: 200
          description: >-
            Specifies the number of friends to return per page. Defaults to 50,
            with a maximum limit of 200 transactions per page.
      responses:
        '200':
          description: Customer referrals retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerReferralsResponse'
      security:
        - apiKey: []
          secretKey: []
components:
  schemas:
    CustomerReferralsResponse:
      type: object
      properties:
        referredFriends:
          type: array
          description: A list of friends referred by the customer.
          items:
            type: object
            properties:
              customerId:
                type: string
                description: Unique identifier for the referred friend.
              displayName:
                type: string
                description: Display name of the referred friend.
              email:
                type: string
                description: Email address of the referred friend.
              mobileNumber:
                type: string
                description: Mobile number of the referred friend.
              joinDate:
                type: string
                description: The date when the referred friend joined.
              status:
                type: string
                enum:
                  - Active
                  - Pending
                description: >-
                  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:
          type: number
          description: The total number of friends on the current page.
        hasMore:
          type: boolean
          description: >-
            Indicating whether there are additional friends to be fetched beyond
            the current page.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: apikey
    secretKey:
      type: apiKey
      in: header
      name: secretkey

````