Get shuttle job by ID
Returns details for a single shuttle job identified by its ID, including its current state, mapping-preparation state, and configured source system.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version header.
2026.0 Path Parameters
The unique identifier for the shuttle job.
Response
Returns the shuttle job.
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.
The unique identifier for the shuttle job.
"6a3ba68e810d9156194530a1"
The value will always be shuttle_job.
shuttle_job "shuttle_job"
The human-readable name of the shuttle job.
"Q4 SharePoint to Box"
The type of work the shuttle job performs.
transfer, analysis "transfer"
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.
"created"
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.
"awaiting_path_mapping"
The source system the shuttle job migrates content from.
An optional free-form comment describing the shuttle job.
"Migrating the finance department archives."
The account mapping configuration that controls how source identities and permissions are translated into Box.
A list of free-form tags associated with the shuttle job.
A single tag associated with the shuttle job.
The tunable settings that control how the shuttle job runs.
