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

# Connect the social platform this link was issued for

> Completes the OAuth handshake for the athlete and platform the token belongs to (ENG-1478). Neither the athlete nor the platform is accepted from the caller: both come from the token, so a link issued for Instagram cannot be used to attach a TikTok account, and one athlete's link can never connect an account for another.
     *
     * On success the token is consumed, so connecting another platform needs another link. A failed token exchange leaves the link redeemable, so the athlete can retry without going back to their agent. `code_verifier` is required by TikTok's PKCE flow and ignored by the others. Rate limited to 10 requests per minute per IP.



## OpenAPI

````yaml /storage/api-docs/api-docs.json post /public/social-link/{token}/connect
openapi: 3.0.0
info:
  title: MOGL Core API
  description: >-
    MOGL Platform Core API — powering athlete NIL deals, brand partnerships,
    agent management, payments, messaging, and more.
     *
     * ## Authentication
     * - **JWT Bearer Token**: Most endpoints require a Bearer token obtained via `/api/login`.
     * - **Server-to-Server API Key**: Internal/lambda/cron endpoints use an `X-API-KEY` header.
     *
     * ## Rate Limiting
     * - Registration & login endpoints: 4–15 requests per minute
     * - Public/influencer endpoints: 200 requests per minute
     * - Authenticated endpoints: standard Laravel throttle
  version: 1.0.0
servers:
  - url: http://localhost/mogl/mogl-backend/api
    description: Local
  - url: https://dev-api.mogl.online/api
    description: Dev
  - url: https://staging-api.mogl.online/api
    description: Staging
  - url: https://api.mogl.online/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Login, registration, password reset
  - name: User Registration - Common
    description: Common user registration & email check
  - name: User Registration - Athlete
    description: Athlete registration & onboarding steps
  - name: User Registration - Partner
    description: Partner/Brand registration & onboarding steps
  - name: User Registration - Agent
    description: Agent registration & onboarding steps
  - name: User Registration - Fan
    description: Fan registration & onboarding steps
  - name: User Profile
    description: User profile management, settings, social media
  - name: Athlete
    description: 'Athlete-specific endpoints: search, details, availability'
  - name: Athlete - Availability Confirmation
    description: Post-hiring availability confirmation workflow
  - name: Athlete - NIL Feed
    description: Athlete NIL feed and partner search
  - name: Athlete - AI Assistant
    description: >-
      AI-powered job assistant for athletes — chat, conversation history, read
      state, and clarification drafts
  - name: Athlete - AI Waitlist
    description: AI Athlete Assistant waitlist status, social proof, and joining
  - name: Partner
    description: Partner/Brand-specific endpoints
  - name: Partner - External Job
    description: External job link & applicant management
  - name: Partner - Deliverable Report
    description: Deliverable detail reports for brands
  - name: Partner - Screening Questions
    description: Screening question reports
  - name: Partner - Contract Management
    description: Brand contract management with athletes
  - name: Partner - Content Library
    description: Brand content library for deliverable assets
  - name: Agent
    description: Agent profile, athlete management, contracts
  - name: Agent - Athletes
    description: Agent-athlete relationship management
  - name: Agent - Stripe
    description: Agent payment methods & billing via Stripe
  - name: Agent - Pay
    description: 'Agent-wide payout feed: money MOGL sends the agent through Stripe Express'
  - name: Agent - Contracts
    description: Agent athlete contract management
  - name: Agent - Availability Confirmation
    description: Agent managing athlete job availability
  - name: Agent - Roster Import
    description: >-
      CSV client list import through CSVBox (ENG-1619 / ENG-1702): session,
      CSVBox webhook, progress, row results, retry
  - name: Agent - Roster Pages
    description: >-
      ENG-1685: My Roster Link, public roster directory, public roster page, and
      roster SEO URL resolution. A roster is the agent's current linked
      athletes; nothing is stored separately.
  - name: Jobs
    description: Job/deal CRUD, search, invitations, hiring, deliverables
  - name: Deals
    description: Deal listing, my deals, bulk operations
  - name: Deal Folder
    description: >-
      Deal folder file workflow — uploads, replacements, approvals, revisions,
      comments. Accessible by athlete, partner/brand, agent, and iOS clients
      (per-action authorisation enforced server-side).
  - name: Deal Folder iOS API
    description: >-
      iOS-only direct-to-S3 multipart upload endpoints for deal folder files
      (initiate/complete for new uploads and replacements). Web clients should
      use the standard `Deal Folder` upload/replace endpoints instead.
  - name: Chat
    description: Messaging, chat contacts, notifications
  - name: Notifications
    description: Notification preferences, in-app notifications
  - name: Payments
    description: Stripe payments, payment history, cards, bulk pay
  - name: Subscription
    description: Brand subscription plans & management
  - name: Public Pages
    description: Public content endpoints (no auth required)
  - name: Public - Influencer/SEO
    description: Public influencer discovery, sitemaps, directories
  - name: Services
    description: Athlete service marketplace
  - name: iOS Device
    description: iOS device tokens, live activities
  - name: Onboarding Tutorial
    description: Onboarding tutorial progress
  - name: MOGL Rosters
    description: Roster management & display
  - name: Internal / Cron
    description: Server-to-server and cron job endpoints
  - name: Internal / AI Assistant Tools
    description: >-
      Server-to-server Athlete Assistant tool gateway used by mogl-ai-service.
      Eight Laravel tools share POST /internal/ai-assistant/tools/{tool}.
      search_kb is Python-local and is not in this path enum.
  - name: Internal / QA Scenario Lab
    description: >-
      Feature-flagged DEV/STAGING-only endpoints called by the authorized Back
      Office QA Scenario Lab.
  - name: Affiliate
    description: Athlete affiliate links & tracking
  - name: Internal
    description: Internal
  - name: Public - Social Linking
    description: Public - Social Linking
paths:
  /public/social-link/{token}/connect:
    post:
      tags:
        - Public - Social Linking
      summary: Connect the social platform this link was issued for
      description: >-
        Completes the OAuth handshake for the athlete and platform the token
        belongs to (ENG-1478). Neither the athlete nor the platform is accepted
        from the caller: both come from the token, so a link issued for
        Instagram cannot be used to attach a TikTok account, and one athlete's
        link can never connect an account for another.
             *
             * On success the token is consumed, so connecting another platform needs another link. A failed token exchange leaves the link redeemable, so the athlete can retry without going back to their agent. `code_verifier` is required by TikTok's PKCE flow and ignored by the others. Rate limited to 10 requests per minute per IP.
      operationId: publicSocialLinkConnect
      parameters:
        - name: token
          in: path
          description: The 64-character token from the URL the agent sent.
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - auth_code
              properties:
                auth_code:
                  description: >-
                    Authorization code returned by the platform's OAuth
                    redirect.
                  type: string
                  example: AQD1x...
                redirect_uri:
                  description: >-
                    Must match the URI registered with the platform:
                    https://app.mogl.online/social-link/callback/{instagram|tiktok|x},
                    with no trailing slash, on the environment's own host. Note
                    X is `x` in the callback path while the platform is
                    `twitter` everywhere in this API.
                  type: string
                  example: https://app.mogl.online/social-link/callback/instagram
                  nullable: true
                code_verifier:
                  description: PKCE verifier. TikTok only.
                  type: string
                  example: dBjftJeZ4CVP...
                  nullable: true
              type: object
      responses:
        '200':
          description: Connected
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: success
                  platform:
                    type: string
                    enum:
                      - instagram
                      - tiktok
                      - twitter
                    example: instagram
                  username:
                    description: >-
                      The account that was just linked, named on the success
                      screen. Null until the platform sync has returned the
                      handle.
                    type: string
                    example: brandon_wimbush7
                    nullable: true
                type: object
        '400':
          description: >-
            The platform rejected the authorization code. The link stays usable
            for a retry.
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: Could not complete the connection. Please try again.
                type: object
        '404':
          description: No such link.
        '410':
          description: The link expired or was already used.
        '422':
          description: auth_code missing.
        '429':
          description: Rate limit exceeded.
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        JWT Bearer token authentication. Use the /api/login endpoint to obtain a
        token.
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.