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>'

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/shared-workspace"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/shared-workspace', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/shared-workspace",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/shared-workspace"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/shared-workspace")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/shared-workspace")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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>",
        "title": "<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.

Unlike GET /workspace, this feed is not per-user: every valid embed caller for the deployment sees the same set, scoped to what the built-in group has 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