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

# List shuttle reports

> Returns a paginated list of reports generated for the shuttle run identified by `run_id`.

> [!NOTE]
>
> Learn more about [Box SDK versioning strategy](https://developer.box.com/guides/tooling/sdks/sdk-versioning.md).


## OpenAPI

````yaml box-openapi-v2026.0.json GET /shuttle_reports
openapi: 3.0.2
info:
  title: Box Platform API
  description: >-
    [Box Platform](https://developer.box.com) provides functionality to provide
    access to content stored within [Box](https://box.com). It provides
    endpoints for basic manipulation of files and folders, management of users
    within an enterprise, as well as more complex topics such as legal holds and
    retention policies.
  termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
  contact:
    name: Box, Inc
    url: https://developer.box.com
    email: devrel@box.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '2026.0'
  x-box-commit-hash: da48f6b132
servers:
  - url: https://api.box.com/2.0
    description: Box Platform API server.
security:
  - OAuth2Security: []
tags:
  - name: Automate Workflows
    description: Endpoints for listing and manually starting Automate workflow actions.
    x-box-tag: automate_workflows
  - name: Convert to Box Note
    description: Create Box Notes from supported source content (for example Markdown).
    x-box-tag: notes
  - name: Document Split
    description: >-
      A set of endpoints used to split a paginated source document into multiple
      files based on user-defined or AI-generated page ranges.
    x-box-tag: document_split
  - name: Query
    description: Query for your items.
    x-box-tag: query
  - name: Shuttle
    description: >-
      Endpoints for managing Box Shuttle, the service that migrates content into
      Box from external sources. Use these endpoints to manage the systems that
      Shuttle migrates content from and the migration jobs that Shuttle runs.
    x-box-tag: shuttle
externalDocs:
  description: Box Developer Documentation.
  url: https://developer.box.com
paths:
  /shuttle_reports:
    get:
      tags:
        - Shuttle
      summary: List shuttle reports
      description: >-
        Returns a paginated list of reports generated for the shuttle run
        identified by `run_id`.
      operationId: get_shuttle_reports_v2026.0
      parameters:
        - $ref: '#/components/parameters/BoxVersionHeader'
        - name: run_id
          in: query
          description: The unique identifier of the shuttle run whose reports to list.
          required: true
          schema:
            type: string
          example: 6a3ba68e810d9156194530a1:42
        - name: marker
          in: query
          description: >-
            Defines the position marker at which to begin returning results.
            This is used when paginating using marker-based pagination.


            This requires `usemarker` to be set to `true`.
          required: false
          schema:
            type: string
          example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
        - name: limit
          in: query
          description: The maximum number of items to return per page.
          required: false
          schema:
            type: integer
            format: int64
            maximum: 1000
          example: 1000
      responses:
        '200':
          description: Returns a paginated list of shuttle reports.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShuttleReports'
        '400':
          description: >-
            Returned when `run_id` is missing or the user has passed in a
            malformed `marker` or `limit` value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '401':
          description: >-
            Returned when the access token provided in the `Authorization`
            header is not recognized or not provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '403':
          description: >-
            Returned when the authenticated user is not an admin or co-admin
            with permission to manage enterprise properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '404':
          description: >-
            Returned when the shuttle run is not found or the user does not have
            access to it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        '429':
          description: >-
            Returned when the user has sent too many requests in a given amount
            of time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
components:
  parameters:
    BoxVersionHeader:
      name: box-version
      in: header
      description: Version header.
      allowEmptyValue: false
      required: true
      schema:
        type: string
        enum:
          - '2026.0'
      example: '2026.0'
  schemas:
    ShuttleReports:
      description: A paginated list of shuttle reports.
      type: object
      allOf:
        - required:
            - entries
          properties:
            entries:
              description: A list of shuttle reports.
              type: array
              items:
                $ref: '#/components/schemas/ShuttleReport'
        - type: object
          description: The part of an API response that describes marker based pagination.
          properties:
            limit:
              description: >-
                The limit that was used for these entries. This will be the same
                as the `limit` query parameter unless that value exceeded the
                maximum value allowed. The maximum value varies by API.
              type: integer
              format: int64
              example: 1000
            next_marker:
              description: The marker for the start of the next page of results.
              type: string
              example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
              nullable: true
            prev_marker:
              description: The marker for the start of the previous page of results.
              type: string
              example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
              nullable: true
      title: Shuttle reports
      x-box-resource-id: shuttle_reports_v2026.0
      x-box-tag: shuttle
    ClientError:
      description: A generic error.
      type: object
      properties:
        type:
          description: The value will always be `error`.
          type: string
          example: error
          enum:
            - error
          nullable: false
        status:
          description: The HTTP status of the response.
          type: integer
          format: int32
          example: 400
          nullable: false
        code:
          description: A Box-specific error code.
          type: string
          example: item_name_invalid
          enum:
            - created
            - accepted
            - no_content
            - redirect
            - not_modified
            - bad_request
            - unauthorized
            - forbidden
            - not_found
            - method_not_allowed
            - conflict
            - precondition_failed
            - too_many_requests
            - internal_server_error
            - unavailable
            - item_name_invalid
            - insufficient_scope
        message:
          description: A short message describing the error.
          type: string
          example: Method Not Allowed
          nullable: false
        context_info:
          description: >-
            A free-form object that contains additional context about the error.
            The possible fields are defined on a per-endpoint basis. `message`
            is only one example.
          type: object
          example:
            message: Something went wrong
          additionalProperties: {}
          nullable: true
        help_url:
          description: A URL that links to more information about why this error occurred.
          type: string
          example: >-
            https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
          nullable: false
        request_id:
          description: >-
            A unique identifier for this response, which can be used when
            contacting Box support.
          type: string
          example: abcdef123456
          nullable: false
      title: Client error
      x-box-resource-id: client_error_v2026.0
    ShuttleReport:
      description: >-
        A report generated asynchronously for a shuttle job run. Keep polling
        while `status` is `pending` or `processing`. Stop when `status` is
        `complete`, `failed`, `canceled`, or `unknown`. The generated Box file
        or folder is `null` until generation finishes.
      type: object
      properties:
        id:
          description: The unique identifier for the shuttle report.
          type: string
          example: 6a3ba8d14f2c91e8370b4d12
        type:
          description: The value will always be `shuttle_report`.
          type: string
          example: shuttle_report
          enum:
            - shuttle_report
        run_id:
          description: >-
            The unique identifier of the shuttle run this report was generated
            for.
          type: string
          example: 6a3ba68e810d9156194530a1:42
        status:
          description: >-
            The generation status of the report. This is an open string whose
            set of values is expected to grow; the currently documented values
            include `pending`, `processing`, `complete`, `failed`, `canceled`,
            and `unknown`. Keep polling `pending` and `processing`. Stop on
            `complete`, `failed`, `canceled`, and `unknown`. Treat any value
            that is not recognized the same as `unknown`: do not fail parsing,
            and do not keep polling.
          type: string
          example: complete
        format:
          description: The output file format of the report.
          type: string
          example: xlsx
          enum:
            - xlsx
            - csv
        sections:
          description: >-
            The sections included in the report. Echoes the sections requested
            on create. This is an open list whose set of values is expected to
            grow; the currently documented values include `files_and_folders`,
            `event_log`, `transfer_overview`, `source_users`, `target_users`,
            `source_collaborators`, `target_collaborators`,
            `source_collaborations`, and `target_collaborations`. Omitted on
            older reports that have no stored section list. New reports always
            include this field.
          type: array
          items:
            type: string
            description: A section included in the report.
            example: event_log
          example:
            - event_log
            - transfer_overview
          minItems: 1
        users_scope:
          description: Which users are included in user-related report sections.
          type: string
          example: migrated
          enum:
            - migrated
            - all
        output:
          description: >-
            The generated Box file or folder. Always present; `null` until
            `status` is `complete`.
          example:
            id: '12345678'
            type: file
          oneOf:
            - $ref: '#/components/schemas/ShuttleReportOutput'
            - title: OpenAPI 3.0 null schema type
              description: The definition for a null schema type in OpenAPI `3.0`.
              type: object
              nullable: true
              additionalProperties: false
        created_at:
          description: When report generation was requested.
          type: string
          format: date-time
          example: '2026-03-15T06:35:00Z'
        completed_at:
          description: >-
            When report generation finished. Always present; `null` while
            generation is still in progress.
          type: string
          format: date-time
          example: '2026-03-15T06:36:12Z'
          nullable: true
      required:
        - id
        - type
        - run_id
        - status
        - format
        - output
        - completed_at
      title: Shuttle report
      x-box-resource-id: shuttle_report_v2026.0
      x-box-tag: shuttle
    ShuttleReportOutput:
      description: A reference to the generated Box file or folder.
      type: object
      properties:
        id:
          description: The unique identifier of the generated Box file or folder.
          type: string
          example: '12345678'
        type:
          description: The Box object type of the generated file or folder.
          type: string
          example: file
          enum:
            - file
            - folder
      required:
        - id
        - type
      title: Shuttle report output
      x-box-resource-id: shuttle_report_output_v2026.0
      x-box-tag: shuttle
  securitySchemes:
    OAuth2Security:
      type: oauth2
      description: >-
        The access token received from the authorization server in the OAuth 2.0
        flow.
      flows:
        authorizationCode:
          authorizationUrl: https://account.box.com/api/oauth2/authorize
          tokenUrl: https://api.box.com/oauth2/token
          scopes:
            root_readonly: Read all files and folders stored in Box
            root_readwrite: Read and write all files and folders stored in Box
            manage_app_users: Provision and manage app users
            manage_managed_users: Provision and manage managed users
            manage_groups: Manage an enterprise's groups
            manage_webhook: Create webhooks programmatically through the API
            manage_enterprise_properties: Manage enterprise properties
            manage_data_retention: Manage data retention polices
            manage_legal_hold: Manage Legal Holds

````