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

# Import progress and final summary

> Poll every few seconds until `is_complete` is true. An import of another agent is reported as not found.



## OpenAPI

````yaml /storage/api-docs/api-docs.json get /agent/roster-imports/{importId}
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:
  /agent/roster-imports/{importId}:
    get:
      tags:
        - Agent - Roster Import
      summary: Import progress and final summary
      description: >-
        Poll every few seconds until `is_complete` is true. An import of another
        agent is reported as not found.
      operationId: agentGetRosterImport
      parameters:
        - name: importId
          in: path
          required: true
          schema:
            type: integer
            example: 12
      responses:
        '200':
          description: Import
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AgentRosterImport'
                type: object
        '404':
          description: Not found, or not this agent's import
      security:
        - bearerAuth: []
components:
  schemas:
    AgentRosterImport:
      description: >-
        One CSV roster import. The counts are the authoritative totals once
        `is_complete` is true; `processed_rows` is read live so the modal can
        show progress.
      properties:
        id:
          type: integer
          example: 12
        uuid:
          type: string
          format: uuid
          example: 3f0c8a52-7d4e-4f8e-9a51-2b6f0d4c1e77
        file_name:
          type: string
          example: roster.csv
          nullable: true
        status:
          description: >-
            completed: every row succeeded. partially_completed: some rows
            failed. failed: no row succeeded.
          type: string
          enum:
            - queued
            - processing
            - completed
            - partially_completed
            - failed
          example: partially_completed
        is_complete:
          description: >-
            True once the import reached a terminal status. Poll GET
            /agent/roster-imports/{importId} until it is.
          type: boolean
          example: true
        total_row_count:
          type: integer
          example: 50
        processed_rows:
          type: integer
          example: 50
        successful_count:
          description: created + updated + already_linked.
          type: integer
          example: 48
        created_count:
          description: New athlete accounts created and added to the roster.
          type: integer
          example: 45
        linked_or_updated_count:
          type: integer
          example: 3
        linked_count:
          description: >-
            Always 0. An import never links an existing account (that row is
            `account_exists`); kept for backward compatibility.
          type: integer
          example: 0
        updated_count:
          description: >-
            Athletes already on this agent's roster whose empty profile fields
            were filled.
          type: integer
          example: 2
        already_linked_count:
          description: Athletes already on this agent's roster; nothing changed.
          type: integer
          example: 1
        failed_or_conflicted_count:
          type: integer
          example: 2
        can_retry:
          description: >-
            True when the import is complete, its contact data has not been
            removed (30 days after completion), and at least one failed row can
            change on retry. Show the Retry action only when true.
          type: boolean
          example: true
        started_at:
          type: string
          example: '2026-10-14 10:15:02'
          nullable: true
        completed_at:
          type: string
          example: '2026-10-14 10:15:09'
          nullable: true
        created_at:
          type: string
          example: '2026-10-14 10:15:01'
      type: object
  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.