List shared workspace items

GET /v1/deployments/{deploymentId}/shared-workspace

List shared workspace items

cURL

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

200

{
  "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>",
        "fromSharedWorkspace": true,
        "title": "<string>"
      },
      "user": {
        "email": "<string>",
        "id": 123,
        "firstName": "<string>",
        "picture": "<string>"
      },
      "userId": 123
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}

List the workspace items (folders, workbooks, reports) that have been shared with embed users via the built-in “All embed users” group or the caller’s per-embed-tenant system:tenant:{embedTenantName} group.

Unlike GET /workspace, this feed is not per-user: every valid embed caller from the same embed tenant sees the same set, scoped to what those groups have been granted. Owner identities are blanked out so they are not exposed to embed users.

Accepts the same folderId, types, search, sorting, and cursor-pagination parameters as GET /workspace. Folders reachable only because a nested item inside them was shared are surfaced as navigation, but their unshared siblings stay hidden.

Authorizations

Authorization · string · header · required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

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

search · 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