> ## 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 path entries > Returns a paginated list of source or target path entries for a shuttle job. Call with only `job_id` and `side` to list the roots, then browse one level at a time using `path`, `path_id`, or both. Each entry includes `path`, `path_id`, `is_directory`, and a `scope` object (`account` or `shared_space`) so a mapping can be created from that row without extra browse state. Valid values depend on the selected system. > [!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_path_entries 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_path_entries: get: tags: - Shuttle summary: List shuttle path entries description: >- Returns a paginated list of source or target path entries for a shuttle job. Call with only `job_id` and `side` to list the roots, then browse one level at a time using `path`, `path_id`, or both. Each entry includes `path`, `path_id`, `is_directory`, and a `scope` object (`account` or `shared_space`) so a mapping can be created from that row without extra browse state. Valid values depend on the selected system. operationId: get_shuttle_path_entries_v2026.0 parameters: - $ref: '#/components/parameters/BoxVersionHeader' - name: job_id in: query description: The unique identifier of the shuttle job whose path entries to list. required: true schema: type: string example: 6a3ba68e810d9156194530a1 - name: side in: query description: The side of the migration to browse. required: true schema: type: string enum: - source - target example: source - name: path in: query description: >- The human-readable parent path whose children are returned. This can be used with or without `path_id`. Omit both, or pass `/` as `path`, to list root entries. required: false schema: type: string minLength: 1 example: /Shared Documents/Projects - name: path_id in: query description: >- The `path_id` value of the parent entry whose children are returned. This can be used with or without `path`. It distinguishes paths with identical names on systems that support stable identifiers. required: false schema: type: string example: 01ABCDEF23456789 - name: account_email in: query description: >- The email of the account whose path entries are returned. This is a system-native identifier and is not always an RFC 5322 address. required: false schema: type: string example: user@example.com - 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 path entries. content: application/json: schema: $ref: '#/components/schemas/ShuttlePathEntries' '400': description: >- Returned when a required parameter is missing, a parameter is malformed, or the selected system cannot browse the supplied combination of `path` and `path_id`. 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 job 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: ShuttlePathEntries: description: A paginated list of shuttle path entries. type: object allOf: - required: - entries properties: entries: description: A list of shuttle path entries. type: array items: $ref: '#/components/schemas/ShuttlePathEntry' - 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 path entries x-box-resource-id: shuttle_path_entries_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 ShuttlePathEntry: description: >- A browsable entry on the source or target system used to build shuttle path mappings. Shared fields describe the node. `scope` is a discriminated object that identifies the mapping namespace so a path mapping can be created from this row without extra browse state. type: object properties: id: description: >- The unique identifier of this browse row. This is not the account identifier; when `scope.type` is `account`, the account identifier is `scope.id`. type: string example: 6a3ba7c02ea17bc9461eeacf type: description: The value will always be `shuttle_path_entry`. type: string example: shuttle_path_entry enum: - shuttle_path_entry name: description: The display name of the path entry. type: string example: Projects path: description: The human-readable path of the entry. type: string example: /Shared Documents/Projects path_id: description: >- The system-native identifier of the path. `null` when the selected system does not provide one. Maps to `path_id` on a path mapping location. type: string example: 01ABCDEF23456789 nullable: true parent_path: description: >- The human-readable path of the parent entry, or `null` for a root entry. type: string example: /Shared Documents nullable: true scope: example: type: shared_space space: HR Team Site allOf: - $ref: '#/components/schemas/ShuttlePathEntryScope' - description: >- The mapping namespace of this entry. Exactly one variant is present, discriminated by `type`. An `account` scope is the owning account flattened onto the object. A `shared_space` scope carries the container name. Whether the entry is a file or a folder is indicated by `is_directory`, not by `scope`. is_directory: description: >- Whether the entry is a directory (`true`) or a single file (`false`). Maps to `is_directory` on a path mapping location. type: boolean example: true can_map: description: Whether the entry can be selected in a path mapping. type: boolean example: true required: - id - type - name - path - scope - is_directory - can_map title: Shuttle path entry x-box-resource-id: shuttle_path_entry_v2026.0 x-box-tag: shuttle ShuttlePathEntryScope: description: >- Which mapping namespace this path entry belongs to. Discriminated by `type`: `account` flattens the owning account onto the object; `shared_space` carries the shared container name. File versus folder is not part of scope. Use `is_directory` on the path entry. oneOf: - $ref: '#/components/schemas/ShuttlePathEntryAccountScope' - $ref: '#/components/schemas/ShuttlePathEntrySharedSpaceScope' title: Shuttle path entry scope x-box-resource-id: shuttle_path_entry_scope_v2026.0 x-box-tag: shuttle ShuttlePathEntryAccountScope: description: >- The mapping scope of a path entry that lives under a user or service account. `type` is the discriminator. The remaining fields are the account itself, flattened onto this object — they are not a nested `account` wrapper. `id` here is the account identifier, not the path entry `id`. Copy these fields onto `account` when creating an account-scoped path mapping. type: object properties: type: description: The value will always be `account`. type: string example: account enum: - account id: description: >- The platform-native identifier of the account that owns this entry. `null` when the system does not provide one. This is not the path entry `id`. Maps to `account.id` on an account-scoped path mapping location. type: string example: '123456' nullable: true email: description: >- The email of the account that owns this entry. This is a system-native identifier and is not always an RFC 5322 address. `null` when unknown. Maps to `account.email` on an account-scoped path mapping location. type: string example: user@example.com nullable: true name: description: >- The display name of the account that owns this entry. `null` when unknown. Maps to `account.name` on an account-scoped path mapping location. type: string example: Jane Doe nullable: true required: - type title: Shuttle path entry account scope x-box-resource-id: shuttle_path_entry_account_scope_v2026.0 x-box-tag: shuttle ShuttlePathEntrySharedSpaceScope: description: >- The mapping scope of a path entry that lives under a shared container such as a site, team drive, bucket, or file share. `type` is the discriminator. Copy `space` onto a shared-space path mapping location when creating a mapping from this row. type: object properties: type: description: The value will always be `shared_space`. type: string example: shared_space enum: - shared_space space: description: >- The display name of the shared container this entry belongs to. `null` when the system has a single implicit container. Maps to `space` on a shared-space path mapping location. type: string example: HR Team Site nullable: true required: - type title: Shuttle path entry shared space scope x-box-resource-id: shuttle_path_entry_shared_space_scope_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 ````