> ## 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.

# Find MLM user by external ID

> Finds an MLM user by their external provider ID.



## OpenAPI

````yaml api/openapi-integration.yaml get /api/v1/auth/user-by-external-id
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/auth/user-by-external-id:
    get:
      tags:
        - Auth
      summary: Find MLM user by external ID
      description: Finds an MLM user by their external provider ID.
      operationId: findUserByExternalId
      parameters:
        - name: externalId
          in: query
          required: true
          schema:
            type: string
        - name: provider
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    $ref: '#/components/schemas/User'
        '404':
          description: User not found
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          format: uuid
        tenantId:
          type: string
          format: uuid
        email:
          type: string
          format: email
        membershipTier:
          type: string
          enum:
            - ORDINARY
            - SENIOR
            - MANAGER
            - DIRECTOR
        parentId:
          type: string
          format: uuid
          nullable: true
        isActive:
          type: boolean
        canRecruit:
          type: boolean
        isTestUser:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    TenantApiKey:
      type: apiKey
      in: header
      name: x-tenant-api-key
      description: Tenant API key for authentication

````