> ## 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 link for a user > Returns the referral link and code for a specific user. The link can be shared to attribute new leads and members to this user. ## OpenAPI ````yaml api/openapi.yaml get /api/v1/referral-link openapi: 3.1.0 info: title: MLM Platform API version: 1.0.0 description: > The MLM Platform API enables tenant developers to integrate commission tracking, member management, and referral systems into their applications. ## Authentication All API requests require a tenant API key passed in the `x-tenant-api-key` header. ## Environments - **LIVE**: Production environment with real data - **SANDBOX**: Test environment for development and testing API keys are scoped to specific environments. Use sandbox keys for testing. The environment is derived from the API key used for the request. The platform returns the selected environment in the response header `X-Environment`. If you send an `X-Environment` request header, it is treated as optional/debug-only. contact: name: MLM Platform Support email: support@mlm-platform.example.com license: name: Proprietary url: https://mlm-platform.example.com/terms servers: - url: https://app.mlm-platform.com description: Production API - url: http://localhost:3000 description: Local Development security: - TenantApiKey: [] tags: - name: Auth description: Token exchange, validation, refresh, and revocation for OIDC federation - name: Events description: Purchase and commission events - name: Users description: Member management - name: Leads description: Lead capture and tracking - name: Referrals description: Referral links and codes - name: Payout description: Payout methods metadata for dynamic payout setup forms - name: Payout Accounts description: Member payout accounts (create/list/update/delete) - name: KYC description: Member KYC start, status, and document submission - name: Admin KYC description: Admin KYC review queue, details, and actions - name: Widget description: Embeddable widget authentication - name: Webhooks description: Webhook receivers for third-party providers (Sumsub) paths: /api/v1/referral-link: get: tags: - Referrals summary: Get referral link for a user description: | Returns the referral link and code for a specific user. The link can be shared to attribute new leads and members to this user. operationId: getReferralLink parameters: - name: user_id in: query required: true description: The user ID to get the referral link for schema: type: string format: uuid responses: '200': description: Referral link retrieved content: application/json: schema: $ref: '#/components/schemas/ReferralLinkResponse' headers: X-Environment: $ref: '#/components/headers/X-Environment' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': description: User not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: schemas: ReferralLinkResponse: type: object properties: user_id: type: string format: uuid description: The MLM user ID referral_code: type: string description: The user's referral code referral_url: type: string format: uri description: Fully-qualified referral URL (derived from tenant settings) is_new: type: boolean description: True if the referral code was newly created for the user ErrorResponse: type: object required: - error properties: error: type: string description: Human-readable error message code: type: string description: Machine-readable error code details: type: object additionalProperties: true description: Additional error details headers: X-Environment: description: >- Indicates the environment (LIVE or SANDBOX) the request was processed in (derived from API key) schema: type: string enum: - LIVE - SANDBOX responses: BadRequest: description: Bad Request - Invalid input content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: Invalid request body code: VALIDATION_ERROR details: field: email message: Invalid email format Unauthorized: description: Unauthorized - Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missing_api_key: summary: Missing API key value: error: Authentication required code: UNAUTHORIZED invalid_api_key: summary: Invalid API key value: error: Invalid API key code: INVALID_API_KEY RateLimited: description: Too Many Requests - Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: Rate limit exceeded. Try again in 60 seconds. code: RATE_LIMITED headers: Retry-After: description: Seconds until rate limit resets schema: type: integer X-RateLimit-Remaining: description: Remaining requests in the current window schema: type: integer X-RateLimit-Reset: description: Unix timestamp (seconds) when the rate limit window resets schema: type: integer InternalError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: An unexpected error occurred code: INTERNAL_ERROR securitySchemes: TenantApiKey: type: apiKey in: header name: x-tenant-api-key description: > Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard. ````