List workspace items

curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workspace \
  --header 'Authorization: <api-key>'

{
  "items": [
    {
      "calculatedFields": {},
      "createdAt": "2023-12-25",
      "deploymentId": 123,
      "id": 123,
      "meta": {},
      "name": "<string>",
      "updatedAt": "2023-12-25",
      "createdBy": 123,
      "dashboardDraft": {
        "description": "<string>",
        "layout": {
          "breakpoints": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "cols": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "containerPadding": [
            123
          ],
          "margin": [
            123
          ],
          "rowHeight": 123
        },
        "settings": {},
        "theme": {},
        "title": "<string>",
        "widgets": [
          {
            "id": "<string>",
            "position": {
              "h": 123,
              "w": 123,
              "x": 123,
              "y": 123
            },
            "config": {},
            "responsiveLayouts": {
              "lg": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "md": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "sm": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xxs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              }
            },
            "style": {}
          }
        ]
      },
      "dashboardPublished": {
        "description": "<string>",
        "layout": {
          "breakpoints": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "cols": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "containerPadding": [
            123
          ],
          "margin": [
            123
          ],
          "rowHeight": 123
        },
        "settings": {},
        "theme": {},
        "title": "<string>",
        "widgets": [
          {
            "id": "<string>",
            "position": {
              "h": 123,
              "w": 123,
              "x": 123,
              "y": 123
            },
            "config": {},
            "responsiveLayouts": {
              "lg": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "md": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "sm": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xxs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              }
            },
            "style": {}
          }
        ]
      },
      "folderId": 123,
      "isFavorite": true,
      "publishedDashboard": {
        "allowEmbed": true,
        "config": {
          "description": "<string>",
          "layout": {
            "breakpoints": {
              "lg": 123,
              "md": 123,
              "sm": 123,
              "xs": 123,
              "xxs": 123
            },
            "cols": {
              "lg": 123,
              "md": 123,
              "sm": 123,
              "xs": 123,
              "xxs": 123
            },
            "containerPadding": [
              123
            ],
            "margin": [
              123
            ],
            "rowHeight": 123
          },
          "settings": {},
          "theme": {},
          "title": "<string>",
          "widgets": [
            {
              "id": "<string>",
              "position": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "config": {},
              "responsiveLayouts": {
                "lg": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "md": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "sm": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "xs": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "xxs": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                }
              },
              "style": {}
            }
          ]
        },
        "deploymentId": 123,
        "id": 123,
        "publicId": "<string>",
        "reportSnapshots": [
          {
            "id": 123,
            "reportId": 123,
            "versionNumber": 123,
            "description": "<string>",
            "meta": {},
            "name": "<string>",
            "preferences": {
              "columnFormats": {}
            },
            "spec": "<string>",
            "sqlQuery": "<string>",
            "title": "<string>"
          }
        ],
        "versionId": 123,
        "versionNumber": 123,
        "workbookId": 123,
        "createdBy": 123,
        "description": "<string>",
        "title": "<string>"
      },
      "userId": 123
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}

Workspace

List workspace items

List the items in a deployment’s workspace — folders, workbooks, and reports — in a single unified, paginated feed.

By default this returns the items at the workspace root. Pass folderId to list the contents of a specific folder instead. Folders are always returned ahead of other item types so they render at the top of a listing.

Supported query parameters:

folderId — list the contents of this folder (omit for the root).
types — restrict the results to one or more item types (FOLDER, WORKBOOK, REPORT). Repeat the parameter to pass several.
search — case-insensitive substring match on item names; searches across all folders, not just the current level.
orderByField / orderByDirection — sort the non-folder items (e.g. by name, updated_at, created_at, or viewer_last_viewed_at).
first / after — cursor-based pagination.

Results are scoped to the calling user: only items the user can access are returned.

GET

deployments

{deploymentId}

workspace

List workspace items

curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/workspace \
  --header 'Authorization: <api-key>'

{
  "items": [
    {
      "calculatedFields": {},
      "createdAt": "2023-12-25",
      "deploymentId": 123,
      "id": 123,
      "meta": {},
      "name": "<string>",
      "updatedAt": "2023-12-25",
      "createdBy": 123,
      "dashboardDraft": {
        "description": "<string>",
        "layout": {
          "breakpoints": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "cols": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "containerPadding": [
            123
          ],
          "margin": [
            123
          ],
          "rowHeight": 123
        },
        "settings": {},
        "theme": {},
        "title": "<string>",
        "widgets": [
          {
            "id": "<string>",
            "position": {
              "h": 123,
              "w": 123,
              "x": 123,
              "y": 123
            },
            "config": {},
            "responsiveLayouts": {
              "lg": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "md": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "sm": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xxs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              }
            },
            "style": {}
          }
        ]
      },
      "dashboardPublished": {
        "description": "<string>",
        "layout": {
          "breakpoints": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "cols": {
            "lg": 123,
            "md": 123,
            "sm": 123,
            "xs": 123,
            "xxs": 123
          },
          "containerPadding": [
            123
          ],
          "margin": [
            123
          ],
          "rowHeight": 123
        },
        "settings": {},
        "theme": {},
        "title": "<string>",
        "widgets": [
          {
            "id": "<string>",
            "position": {
              "h": 123,
              "w": 123,
              "x": 123,
              "y": 123
            },
            "config": {},
            "responsiveLayouts": {
              "lg": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "md": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "sm": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "xxs": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              }
            },
            "style": {}
          }
        ]
      },
      "folderId": 123,
      "isFavorite": true,
      "publishedDashboard": {
        "allowEmbed": true,
        "config": {
          "description": "<string>",
          "layout": {
            "breakpoints": {
              "lg": 123,
              "md": 123,
              "sm": 123,
              "xs": 123,
              "xxs": 123
            },
            "cols": {
              "lg": 123,
              "md": 123,
              "sm": 123,
              "xs": 123,
              "xxs": 123
            },
            "containerPadding": [
              123
            ],
            "margin": [
              123
            ],
            "rowHeight": 123
          },
          "settings": {},
          "theme": {},
          "title": "<string>",
          "widgets": [
            {
              "id": "<string>",
              "position": {
                "h": 123,
                "w": 123,
                "x": 123,
                "y": 123
              },
              "config": {},
              "responsiveLayouts": {
                "lg": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "md": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "sm": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "xs": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                },
                "xxs": {
                  "h": 123,
                  "w": 123,
                  "x": 123,
                  "y": 123
                }
              },
              "style": {}
            }
          ]
        },
        "deploymentId": 123,
        "id": 123,
        "publicId": "<string>",
        "reportSnapshots": [
          {
            "id": 123,
            "reportId": 123,
            "versionNumber": 123,
            "description": "<string>",
            "meta": {},
            "name": "<string>",
            "preferences": {
              "columnFormats": {}
            },
            "spec": "<string>",
            "sqlQuery": "<string>",
            "title": "<string>"
          }
        ],
        "versionId": 123,
        "versionNumber": 123,
        "workbookId": 123,
        "createdBy": 123,
        "description": "<string>",
        "title": "<string>"
      },
      "userId": 123
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}

Authorizations

Authorization

string

header

required

API key authentication. Send Authorization: Api-Key <YOUR_API_KEY>.

Path Parameters

deploymentId

number

required

Query Parameters

folderId

integer | null

types

enum<string>[] | null

Available options:

FOLDER,

WORKBOOK,

REPORT

orderByField

enum<string> | null

Available options:

updated_at,

created_at,

name,

viewer_last_viewed_at

orderByDirection

enum<string> | null

Available options:

ASC,

DESC

string | null

after

string

first

integer

Required range: x >= 1

Response

200 - application/json

items

object[]

required

Show child attributes

pageInfo

object

required

Show child attributes

List shared workspace items Move a workspace item

⌘I