> ## 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. # Get shuttle run by ID > Returns details for a single shuttle run identified by its ID, including its mode, state, timing, and transfer statistics. > [!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_runs/{shuttle_run_id} 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_runs/{shuttle_run_id}: get: tags: - Shuttle summary: Get shuttle run by ID description: >- Returns details for a single shuttle run identified by its ID, including its mode, state, timing, and transfer statistics. operationId: get_shuttle_runs_id_v2026.0 parameters: - $ref: '#/components/parameters/BoxVersionHeader' - name: shuttle_run_id in: path description: >- The unique identifier for the shuttle run, in the form `{job_id}:{run_number}`. required: true schema: type: string example: 6a3ba68e810d9156194530a1:42 responses: '200': description: Returns the shuttle run. content: application/json: schema: $ref: '#/components/schemas/ShuttleRun' '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: ShuttleRun: description: >- A historical instance of a shuttle job run. A run is created each time a job is started. Run IDs have the form `{job_id}:{run_number}`. type: object properties: id: description: >- The unique identifier for the shuttle run, in the form `{job_id}:{run_number}`. type: string example: 6a3ba68e810d9156194530a1:42 type: description: The value will always be `shuttle_run`. type: string example: shuttle_run enum: - shuttle_run job_id: description: The unique identifier of the shuttle job this run belongs to. type: string example: 6a3ba68e810d9156194530a1 run_mode: description: >- The mode the run was started in. This is an open string whose set of values is expected to grow; the currently documented values include `transfer`, `simulation`, `analysis`, `scan`, and `unknown`. Clients should treat any value they do not recognize as `unknown`. type: string example: transfer state: description: >- The current state of the shuttle run. This is an open string whose set of values is expected to grow; the currently documented values include `running`, `stopping`, `completed`, `completed_with_errors`, `stopped`, `failed`, `timed_out`, and `unknown`. Clients should treat any value they do not recognize as `unknown`. type: string example: completed started_at: description: When the run started. type: string format: date-time example: '2026-03-15T02:00:00Z' ended_at: description: When the run ended. `null` while the run is still in progress. type: string format: date-time example: '2026-03-15T06:30:00Z' nullable: true duration_seconds: description: >- Total duration of the run in seconds. `null` while the run is still in progress. type: integer format: int64 example: 16200 nullable: true stats: description: Transfer statistics collected during the run. type: object properties: bytes_sent: description: Bytes transferred during the run. type: integer format: int64 example: 1073741824 files_sent: description: Files transferred during the run. type: integer format: int64 example: 4200 folders_created: description: Folders created on the destination during the run. type: integer format: int64 example: 350 is_estimated: description: Whether these figures are estimates rather than final counts. type: boolean example: false x-box-tag: shuttle created_by: description: >- The user who started the run. `null` for schedule- or system-initiated runs. example: id: '11446498' type: user oneOf: - $ref: '#/components/schemas/User--Base' - 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 available_report_sections: description: >- Report sections that can be requested for this run. 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`. type: array items: type: string description: A report section available for this run. example: event_log example: - event_log - files_and_folders required: - id - type - job_id - run_mode - state title: Shuttle run x-box-resource-id: shuttle_run_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 User--Base: description: >- A mini representation of a user, used when nested within another resource. type: object properties: id: description: The unique identifier for this user. type: string example: '11446498' type: description: The value will always be `user`. type: string example: user enum: - user nullable: false required: - type - id title: User (Base) 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 ````