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

# Get referral statistics

> Returns referral statistics for a member.



## OpenAPI

````yaml api/openapi-integration.yaml get /api/v1/members/{userId}/referral-stats
openapi: 3.1.0
info:
  title: MLM Platform Integration API
  version: 1.0.0
  description: >
    Tenant integrator APIs for external platform federation and member-data
    access,

    including OIDC token exchange, external user linking, genealogy, referrals,
    and commissions.


    ## Authentication

    All API requests require a tenant API key passed in the `x-tenant-api-key`
    header.


    ## Token Exchange

    External platforms can exchange their JWT tokens for MLM platform tokens
    using

    the `/api/v1/auth/exchange` endpoint.
  contact:
    name: MLM Platform Support
    email: support@mlm-platform.example.com
servers:
  - url: https://app.mlm-platform.com
    description: Production API
  - url: http://localhost:3000
    description: Local Development
security:
  - TenantApiKey: []
tags:
  - name: Auth
    description: Authentication and token exchange
  - name: Genealogy
    description: Member hierarchy and relationships
  - name: Referrals
    description: Referral statistics and QR codes
  - name: Commissions
    description: Commission history and breakdowns
  - name: Webhooks
    description: Webhook receivers for third-party providers (Stripe, Wise)
paths:
  /api/v1/members/{userId}/referral-stats:
    get:
      tags:
        - Referrals
      summary: Get referral statistics
      description: Returns referral statistics for a member.
      operationId: getReferralStats
      parameters:
        - name: userId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Referral statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralStats'
        '404':
          description: User not found
components:
  schemas:
    ReferralStats:
      type: object
      properties:
        totalReferrals:
          type: integer
        directReferrals:
          type: integer
        referralsThisMonth:
          type: integer
        conversionRate:
          type: number
        totalCommissionFromReferrals:
          type: number
        topPerformers:
          type: array
          items:
            $ref: '#/components/schemas/ReferralPerformer'
    ReferralPerformer:
      type: object
      properties:
        userId:
          type: string
          format: uuid
        email:
          type: string
        name:
          type: string
          nullable: true
          description: Display name (computed from givenName and surname)
        givenName:
          type: string
          nullable: true
          description: Given/first name
        surname:
          type: string
          nullable: true
          description: Surname/family name
        referralCount:
          type: integer
        commissionGenerated:
          type: number
  securitySchemes:
    TenantApiKey:
      type: apiKey
      in: header
      name: x-tenant-api-key
      description: Tenant API key for authentication

````