Skip to content

Get the whole vault tree in one read

GET
/vault/tree
curl --request GET \
--url https://api.engram.page/vault/tree \
--header 'Authorization: Bearer <token>'

Every folder, note and attachment the file tree renders, in one response.

Vault tree

Media typeapplication/json
VaultTreeResponse
object
attachments
Array<object>
VaultTreeAttachment
object
id
required
string format: uuid
mime_type
string
nullable
mtime
required

Client mtime (epoch seconds)

number format: float
path
required
string
size_bytes
required
integer
updated_at
required
string format: date-time
change_seq
required

Current per-vault sequence watermark.

integer
folder_tree

Only while the server’s folder-row reads are on: every live folder row, parents first. The root has no entry; its children have parent_id null.

Array<object>
FolderNode
object
id
required
string format: uuid
name
required

One path segment.

string
parent_id
required

Null for a child of the root (the root has no row).

string format: uuid
nullable
folders
Array<object>
Folder
object
count
integer
id
string format: uuid
nullable
name
required
string
parent_id
string format: uuid
nullable
notes
Array<object>
VaultTreeNote
object
created_at
required
string format: date-time
folder_id

With folder_tree only: the note’s folder row (null at the root, or for a folder with no row yet).

string format: uuid
nullable
id
required
string format: uuid
name

With folder_tree only: the last segment of path.

string
path
required
string
updated_at
required
string format: date-time

Example generated

{
"attachments": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"mime_type": "example",
"mtime": 1,
"path": "example",
"size_bytes": 1,
"updated_at": "2026-04-15T12:00:00Z"
}
],
"change_seq": 1,
"folder_tree": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"parent_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
],
"folders": [
{
"count": 1,
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"parent_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
],
"notes": [
{
"created_at": "2026-04-15T12:00:00Z",
"folder_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"path": "example",
"updated_at": "2026-04-15T12:00:00Z"
}
]
}