---
title: "Move a workspace item"
method: POST
path: "/api/v1/deployments/{deploymentId}/workspace/move"
tags: ["Workspace"]
---

# Move a workspace item

`POST /api/v1/deployments/{deploymentId}/workspace/move`

## Path parameters

- `deploymentId` number, required

## Request body

- MoveWorkspaceObjectInput
  - `folderId` integer, nullable
  - `id` integer, required
  - `type` 'FOLDER' | 'WORKBOOK' | 'REPORT', required

## Response `200`

- Workbook
  - `calculatedFields` object, required
  - `createdAt` union, required
    - string, date
    - string, date-time
  - `createdBy` integer
  - `dashboardDraft` DashboardConfig
    - `app` DashboardAppSource
      - `entry` string, nullable
      - `files` object, nullable
      - `html` string, nullable
      - `manifest` DashboardAppManifest
        - `dependencies` object, nullable
        - `version` integer, nullable
    - `description` string, nullable
    - `kind` 'CLASSIC' | 'APP'
    - `layout` DashboardLayout
      - `breakpoints` DashboardBreakpoints
        - `lg` integer, nullable
        - `md` integer, nullable
        - `sm` integer, nullable
        - `xs` integer, nullable
        - `xxs` integer, nullable
      - `cols` DashboardBreakpointCols
        - `lg` integer, nullable
        - `md` integer, nullable
        - `sm` integer, nullable
        - `xs` integer, nullable
        - `xxs` integer, nullable
      - `containerPadding` integer[], nullable
      - `margin` integer[], nullable
      - `rowHeight` integer, nullable
    - `settings` object, nullable
    - `theme` object, nullable
    - `title` string, nullable
    - `widgets` DashboardWidget[], nullable
      - `config` object, nullable
      - `id` string, required
      - `position` DashboardWidgetPosition, required
        - `h` integer, required
        - `w` integer, required
        - `x` integer, required
        - `y` integer, required
      - `responsiveLayouts` DashboardResponsiveLayouts
        - `lg` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
        - `md` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
        - `sm` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
        - `xs` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
        - `xxs` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
      - `style` object, nullable
      - `type` 'CHART' | 'TEXT' | 'FILTER' | 'AI' | 'TABS_CONTAINER' | 'TIME_GRAIN', required
  - `dashboardPublished` DashboardConfig
    - `app` DashboardAppSource
      - `entry` string, nullable
      - `files` object, nullable
      - `html` string, nullable
      - `manifest` DashboardAppManifest
        - `dependencies` object, nullable
        - `version` integer, nullable
    - `description` string, nullable
    - `kind` 'CLASSIC' | 'APP'
    - `layout` DashboardLayout
      - `breakpoints` DashboardBreakpoints
        - `lg` integer, nullable
        - `md` integer, nullable
        - `sm` integer, nullable
        - `xs` integer, nullable
        - `xxs` integer, nullable
      - `cols` DashboardBreakpointCols
        - `lg` integer, nullable
        - `md` integer, nullable
        - `sm` integer, nullable
        - `xs` integer, nullable
        - `xxs` integer, nullable
      - `containerPadding` integer[], nullable
      - `margin` integer[], nullable
      - `rowHeight` integer, nullable
    - `settings` object, nullable
    - `theme` object, nullable
    - `title` string, nullable
    - `widgets` DashboardWidget[], nullable
      - `config` object, nullable
      - `id` string, required
      - `position` DashboardWidgetPosition, required
        - `h` integer, required
        - `w` integer, required
        - `x` integer, required
        - `y` integer, required
      - `responsiveLayouts` DashboardResponsiveLayouts
        - `lg` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
        - `md` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
        - `sm` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
        - `xs` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
        - `xxs` DashboardWidgetPosition
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
      - `style` object, nullable
      - `type` 'CHART' | 'TEXT' | 'FILTER' | 'AI' | 'TABS_CONTAINER' | 'TIME_GRAIN', required
  - `deploymentId` integer, required
  - `folderId` number, nullable
  - `folderPath` WorkspaceFolderPathEntry[]
    - `id` integer, required
    - `name` string, required
  - `id` integer, required
  - `isFavorite` boolean, nullable
  - `meta` object, required
  - `name` string, required
  - `publishedDashboard` Dashboard
    - `allowEmbed` boolean, required
    - `config` DashboardConfig, required
      - `app` DashboardAppSource
        - `entry` string, nullable
        - `files` object, nullable
        - `html` string, nullable
        - `manifest` DashboardAppManifest
          - `dependencies` object, nullable
          - `version` integer, nullable
      - `description` string, nullable
      - `kind` 'CLASSIC' | 'APP'
      - `layout` DashboardLayout
        - `breakpoints` DashboardBreakpoints
          - `lg` integer, nullable
          - `md` integer, nullable
          - `sm` integer, nullable
          - `xs` integer, nullable
          - `xxs` integer, nullable
        - `cols` DashboardBreakpointCols
          - `lg` integer, nullable
          - `md` integer, nullable
          - `sm` integer, nullable
          - `xs` integer, nullable
          - `xxs` integer, nullable
        - `containerPadding` integer[], nullable
        - `margin` integer[], nullable
        - `rowHeight` integer, nullable
      - `settings` object, nullable
      - `theme` object, nullable
      - `title` string, nullable
      - `widgets` DashboardWidget[], nullable
        - `config` object, nullable
        - `id` string, required
        - `position` DashboardWidgetPosition, required
          - `h` integer, required
          - `w` integer, required
          - `x` integer, required
          - `y` integer, required
        - `responsiveLayouts` DashboardResponsiveLayouts
          - `lg` DashboardWidgetPosition
            - `h` integer, required
            - `w` integer, required
            - `x` integer, required
            - `y` integer, required
          - `md` DashboardWidgetPosition
            - `h` integer, required
            - `w` integer, required
            - `x` integer, required
            - `y` integer, required
          - `sm` DashboardWidgetPosition
            - `h` integer, required
            - `w` integer, required
            - `x` integer, required
            - `y` integer, required
          - `xs` DashboardWidgetPosition
            - `h` integer, required
            - `w` integer, required
            - `x` integer, required
            - `y` integer, required
          - `xxs` DashboardWidgetPosition
            - `h` integer, required
            - `w` integer, required
            - `x` integer, required
            - `y` integer, required
        - `style` object, nullable
        - `type` 'CHART' | 'TEXT' | 'FILTER' | 'AI' | 'TABS_CONTAINER' | 'TIME_GRAIN', required
    - `createdBy` integer, nullable
    - `deploymentId` integer, required
    - `description` string, nullable
    - `fromSharedWorkspace` boolean, nullable
    - `id` integer, required
    - `publicId` string, required
    - `reportSnapshots` ReportSnapshot[], required
      - `description` string, nullable
      - `fillMissingRows` FillMissingRows
        - `excludedDimensions` string[], nullable
        - `member` string, required
      - `id` integer, required
      - `kind` 'vega' | 'table' | 'kpi' | 'html' | 'map'
      - `meta` object, nullable
      - `name` string, nullable
      - `periodComparisons` PeriodComparison[], nullable
        - `measure` string, required
        - `offset` PeriodComparisonOffset, required
          - `amount` integer, required
          - `unit` string, required
        - `outputs` string[], nullable
        - `timeDimension` string, required
      - `preferences` ReportSnapshotPreferences
        - `columnFormats` object, nullable
      - `reportId` integer, required
      - `spec` union
        - string
        - object
      - `sqlQuery` string, nullable
      - `title` string, nullable
      - `versionNumber` integer, required
    - `restrictDataDownload` boolean, nullable
    - `status` 'draft' | 'published' | 'archived', required
    - `title` string, nullable
    - `useBoardDashboards` boolean, nullable
    - `versionId` integer, required
    - `versionNumber` integer, required
    - `workbookId` integer, required
  - `slug` string, nullable
  - `type` 'FOLDER' | 'WORKBOOK' | 'REPORT', required
  - `updatedAt` union, required
    - string, date
    - string, date-time
  - `user` ResourceOwner
    - `email` string, required
    - `firstName` string, nullable
    - `id` integer, required
    - `picture` string, nullable
  - `userId` number, nullable

---

[API](https://skmtc.net/cube-js/apis/cube-cloud-rest-api.md) · [All operations](https://skmtc.net/cube-js/apis/cube-cloud-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cube-js/cube-cloud-rest-api/revisions/a0c6b1d2ac96/schema)
