> ## 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 jobs > Returns a paginated list of shuttle jobs accessible to the authenticated user. > [!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_jobs 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_jobs: get: tags: - Shuttle summary: List shuttle jobs description: >- Returns a paginated list of shuttle jobs accessible to the authenticated user. operationId: get_shuttle_jobs_v2026.0 parameters: - $ref: '#/components/parameters/BoxVersionHeader' - 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 jobs. content: application/json: schema: $ref: '#/components/schemas/ShuttleJobs' '400': description: >- Returned when 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' '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: ShuttleJobs: description: A paginated list of shuttle jobs. type: object allOf: - required: - entries properties: entries: description: A list of shuttle jobs. type: array items: $ref: '#/components/schemas/ShuttleJob' - 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 jobs x-box-resource-id: shuttle_jobs_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 ShuttleJob: description: >- A standard representation of a shuttle job. A shuttle job describes a migration of content from a source system into Box, including its current state, mapping-preparation state, and mapping configuration. type: object properties: id: description: The unique identifier for the shuttle job. type: string example: 6a3ba68e810d9156194530a1 type: description: The value will always be `shuttle_job`. type: string example: shuttle_job enum: - shuttle_job name: description: The human-readable name of the shuttle job. type: string example: Q4 SharePoint to Box comment: description: An optional free-form comment describing the shuttle job. type: string example: Migrating the finance department archives. nullable: true job_type: description: The type of work the shuttle job performs. type: string example: transfer enum: - transfer - analysis state: description: >- The current state of the shuttle job. This is an open string whose set of values is expected to grow; the currently documented values include `created`, `started`, `stopped`, `completed`, `failed`, `invalid`, and `unknown`. Clients should treat any value they do not recognize as `unknown`. type: string example: created mapping_state: description: >- The current mapping-preparation state of the job. This is an open string whose set of values is expected to grow; the currently documented values include `awaiting_path_mapping`, `importing_paths`, `paths_import_rejected`, `paths_invalid`, `paths_ready`, `scanning_source`, `source_scan_failed`, `source_scan_out_of_date`, `awaiting_subject_mapping`, `importing_subjects`, `subjects_import_rejected`, `mapping_complete`, `building_map`, `map_build_failed`, `map_out_of_date`, and `ready`. `paths_import_rejected` means the last path-mapping spreadsheet was rejected or failed and the path mappings have not been changed since; it clears on the next import or the next manual path-mapping change. `subjects_import_rejected` means the last subject-mapping spreadsheet was rejected or failed and the subject mappings have not been changed since; it clears on the next import or the next manual subject-mapping change. type: string example: awaiting_path_mapping source_system: description: The source system the shuttle job migrates content from. type: object properties: type: description: The value will always be `shuttle_system`. type: string example: shuttle_system enum: - shuttle_system id: description: The unique identifier for the source system. type: string example: 6a3ba68e810d9156194530a1 name: description: The human-readable name of the source system. type: string example: SharePoint required: - type - id - name x-box-tag: shuttle account_mapping: description: >- The account mapping configuration that controls how source identities and permissions are translated into Box. type: object properties: is_enabled: description: Whether account mapping is enabled for the shuttle job. type: boolean example: true permission_conflict_strategy: description: >- The strategy used to resolve permission conflicts. `null` when unset. example: preserve_structure_restrict_sharing oneOf: - $ref: '#/components/schemas/ShuttleJobPermissionConflictStrategy' - 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 are_external_shares_mapped: description: Whether external shares are mapped during the migration. type: boolean example: false are_permissions_mapped: description: Whether permissions are mapped during the migration. type: boolean example: true required: - is_enabled x-box-tag: shuttle tags: description: A list of free-form tags associated with the shuttle job. type: array items: type: string description: A single tag associated with the shuttle job. example: q4 example: - q4 - hr settings: description: The tunable settings that control how the shuttle job runs. type: object properties: bandwidth_limit_bytes_per_sec: description: >- The maximum transfer bandwidth in bytes per second. `null` when unlimited. type: integer format: int64 example: 10485760 nullable: true are_deletions_mirrored: description: Whether deletions in the source system are mirrored in Box. type: boolean example: false are_file_versions_synced: description: Whether prior file versions are synced during the migration. type: boolean example: true max_file_versions: description: >- The maximum number of file versions to sync. `null` when unlimited. type: integer format: int32 example: 10 nullable: true is_overwrite_enabled: description: Whether existing files in Box are overwritten. type: boolean example: false are_completed_mappings_skipped_on_rerun: description: >- Whether mappings that already completed successfully are skipped when the job is rerun. type: boolean example: true is_content_scanning_enabled: description: >- Whether migrated content is scanned during the migration. Applies only when the source system supports content scanning; ignored otherwise. type: boolean example: false include_shared_source_folders: description: >- Whether shared folders on the source are included in the migration. Applies only when the source system supports shared folders; ignored otherwise. type: boolean example: true include_shared_destination_folders: description: >- Whether shared folders on the destination are included in the migration. Applies only when the destination system supports shared folders; ignored otherwise. type: boolean example: false x-box-tag: shuttle required: - id - type - name - job_type - state - mapping_state - source_system title: Shuttle job x-box-resource-id: shuttle_job_v2026.0 x-box-tag: shuttle ShuttleJobPermissionConflictStrategy: description: The strategy used to resolve permission conflicts. type: string example: preserve_structure_restrict_sharing enum: - preserve_structure_restrict_sharing - preserve_structure_expand_sharing - preserve_sharing_modify_structure - warn_permissions_conflicts title: Shuttle job permission conflict strategy x-box-resource-id: shuttle_job_permission_conflict_strategy_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 ````