List folders

GET /v1/deployments/{deploymentId}/folders

List folders

cURL

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

200

{
  "data": [
    {
      "createdAt": "2023-12-25",
      "deploymentId": 123,
      "id": 123,
      "name": "<string>",
      "position": 123,
      "type": "FOLDER",
      "updatedAt": "2023-12-25",
      "createdBy": 123,
      "parentId": 123,
      "updatedBy": 123
    }
  ],
  "items": [
    {
      "createdAt": "2023-12-25",
      "deploymentId": 123,
      "id": 123,
      "name": "<string>",
      "position": 123,
      "type": "FOLDER",
      "updatedAt": "2023-12-25",
      "createdBy": 123,
      "parentId": 123,
      "updatedBy": 123
    }
  ],
  "count": 1,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}

List the folders in a deployment’s workspace.

By default this returns the folders at the workspace root. Pass the parentId query parameter to list the direct children of a specific folder instead.

Results are scoped to the calling user: only folders the user can see are returned. A folder is visible when the user owns it, has been granted access to it directly, or has access to something inside it (a sub-folder, workbook, or dashboard), in which case the ancestor folders are surfaced as navigation.

This endpoint is not recursive — it returns a single level of the folder tree per call. Use parentId to walk deeper, or GET /folders/{folderId}/ancestors to resolve a breadcrumb path.

Results are returned in pages using cursor-based pagination: pass first to set the page size and after (the previous response’s pageInfo.endCursor) to fetch the next page. The legacy data and count fields are still populated for backwards compatibility but are deprecated in favour of items and pageInfo.

Authorizations

Authorization · string · header · required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId · number · required

Query Parameters

parentId · integer | null

Required range: x >= 0

after · string

first · integer

Required range: x >= 1

Response

200 - application/json

data · object[] · required · deprecated

Deprecated: use items instead. Kept for backward compatibility.

Show child attributes

items · object[] · required

Show child attributes

count · integer | null · deprecated

Deprecated: total number of accessible folders, ignoring pagination. Kept for backward compatibility.

Required range: x >= 0

pageInfo · object | null

Show child attributes