Nodes

List nodes (workspace tree, or a flat summary list by type)

get/api/v1/nodes

Request

  • Base URL: https://api-docs.busabase.com
  • URL: https://api-docs.busabase.com/api/v1/nodes
  • Auth: none declared

Query parameters

parentIdstring

Node to start from. Omit or null to start from the space root.

depthinteger

How many levels beneath the start point to eagerly include (default 2 once either field is set). Capped at 5.

status'active' | 'archived'

active walks the live TREE. archived returns a FLAT list of soft-archived nodes (the Trash view) with no parent/depth walk — so the response shape you can rely on differs between the two, not just the rows.

string[]
OR
'folder' | 'base' | 'skill' | 'drive' | 'airapp' | 'file' | 'doc' | 'form' | 'whiteboard' | 'workflow' | 'html'

Response

Workspace node tree including folders, Bases, files, and agents. With no parentId/depth, returns the FULL tree (legacy behavior, still what every non-sidebar caller gets). Passing parentId and/or depth switches to a depth-bounded fetch: parentId omitted/null starts from the space root and returns it wrapped exactly like the legacy call (just depth-limited); an explicit parentId returns that node's children directly, ready to merge into its NodeVO.children for a sidebar's lazy per-folder expand. See NodeVO.hasChildren for how a depth boundary is surfaced. Passing types instead returns a FLAT, ACL-filtered list of lightweight summaries (children: []) for just those node types — this is what replaced GET /docs, /files, /folders, and /file-trees, and it deliberately hydrates nothing heavy (no Doc bodies, backing Assets, folder children, or file inventories). Open one item with GET /nodes/{nodeId}.

idstring required
parentIdstring required
type'folder' | 'base' | 'skill' | 'drive' | 'airapp' | 'file' | 'doc' | 'form' | 'whiteboard' | 'workflow' | 'html' required
slugstring required
namestring required
descriptionstring required
explicitVisibility'private' | 'workspace' | 'public'
positionnumber required
createdAtstring required
updatedAtstring required
baseIdstring required
hasChildrenboolean
sharedboolean
sharedViaAncestorboolean

Changes

No recorded changes to this operation across all 1 revision of this API.