> ## 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 job schedule > Retrieves the shuttle job schedule identified by its 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_job_schedules/{shuttle_job_schedule_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_job_schedules/{shuttle_job_schedule_id}: get: tags: - Shuttle summary: Get shuttle job schedule description: Retrieves the shuttle job schedule identified by its ID. operationId: get_shuttle_job_schedules_id_v2026.0 parameters: - $ref: '#/components/parameters/BoxVersionHeader' - name: shuttle_job_schedule_id in: path description: The unique identifier for the shuttle job schedule. required: true schema: type: string example: 7c1ba68e810d9156194530b2 responses: '200': description: Returns the shuttle job schedule. content: application/json: schema: $ref: '#/components/schemas/ShuttleJobSchedule' '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 job schedule 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: ShuttleJobSchedule: description: >- A schedule that starts runs of a shuttle job. A schedule is either time-based or triggered by another job's run. Schedules cannot start a run in `scan` mode. type: object properties: id: description: The unique identifier for the shuttle job schedule. type: string example: 7c1ba68e810d9156194530b2 type: description: The value will always be `shuttle_job_schedule`. type: string example: shuttle_job_schedule enum: - shuttle_job_schedule job_id: description: The unique identifier of the shuttle job this schedule belongs to. type: string example: 6a3ba68e810d9156194530a1 state: description: Whether the schedule is active. type: string example: enabled enum: - enabled - paused run_mode: description: >- The kind of run the schedule starts. `scan` is not a valid schedule run mode. type: string example: transfer enum: - transfer - simulation - analysis description: description: An optional human-readable description of the schedule. type: string example: Nightly finance share replay. nullable: true last_attempt_at: description: >- When the schedule last attempted to start a run. `null` when the schedule has never started a run. type: string format: date-time example: '2026-03-16T09:00:12Z' nullable: true trigger: $ref: '#/components/schemas/ShuttleJobScheduleTrigger' required: - id - type - job_id - state - run_mode - trigger title: Shuttle job schedule x-box-resource-id: shuttle_job_schedule_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 ShuttleJobScheduleTrigger: description: >- When a shuttle job schedule should start a run. Exactly one trigger variant is present, discriminated by `type`. oneOf: - $ref: '#/components/schemas/ShuttleJobScheduleTriggerByTime' - $ref: '#/components/schemas/ShuttleJobScheduleTriggerByJob' title: Shuttle job schedule trigger x-box-resource-id: shuttle_job_schedule_trigger_v2026.0 x-box-tag: shuttle ShuttleJobScheduleTriggerByTime: description: >- A time-based trigger that starts the schedule at a wall-clock time and optionally repeats. type: object properties: type: description: The value will always be `by_time`. type: string example: by_time enum: - by_time start_at: description: >- The local wall-clock time when the schedule should first start a run, without an offset or `Z` suffix. Combined with `time_zone` to determine the instant, including DST. type: string example: '2026-03-16T09:00:00' pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ time_zone: description: >- The IANA time zone that gives `start_at` its calendar meaning (for example `America/Los_Angeles`). Recurrence and DST transitions are evaluated in this zone. type: string example: America/Los_Angeles repeat: description: How often the schedule repeats after `start_at`. type: string example: daily enum: - none - daily - weekly - weekdays - weekends required: - type - start_at - time_zone - repeat title: Shuttle job schedule trigger by time x-box-resource-id: shuttle_job_schedule_trigger_by_time_v2026.0 x-box-tag: shuttle ShuttleJobScheduleTriggerByJob: description: >- A job-based trigger that starts this schedule after another shuttle job's run meets a condition. type: object properties: type: description: The value will always be `by_job`. type: string example: by_job enum: - by_job triggered_by_job_id: description: >- The unique identifier of the shuttle job whose run starts this schedule. type: string example: 8d2ca68e810d9156194530c3 last_run_condition: description: >- When this schedule should start a run relative to the last run of the triggering job. type: string example: on_success enum: - always - on_success - on_finish required: - type - triggered_by_job_id - last_run_condition title: Shuttle job schedule trigger by job x-box-resource-id: shuttle_job_schedule_trigger_by_job_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 ````