Skip to main content
GET
Error
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

​
fastapiusersauth
string
cookie
required

Path Parameters

​
workspace_id
string<uuid>
required

Query Parameters

​
parent_path
string
default:/

Parent folder path

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
​
path
string
required
​
workspace_id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required