Skip to content

List notes in a folder (metadata only)

GET
/folders/list
curl --request GET \
--url 'https://api.engram.page/folders/list?folder=example' \
--header 'Authorization: Bearer <token>'

Returns metadata (no content) for the notes in the folder named by the required folder query param. Returns 400 when the param is missing.

folder
required
string

Folder path

Folder notes

Media typeapplication/json
FolderListResponse
object
folder
required
string
notes
required
Array<object>
NoteMeta
object
content_hash
string
nullable
folder
string
nullable
id
string format: uuid
nullable
mtime
number format: float
parse_reason

Present when parse_status is “degraded”: {code, message, detail}

object
parse_status

Frontmatter parse outcome

string
nullable
Allowed values: ok degraded
path
required
string
tags
Array<string>
title
string
nullable
updated_at
string format: date-time
nullable
version
integer
nullable
Example
{
"notes": [
{
"parse_status": "ok"
}
]
}

Missing folder param

Media typeapplication/json
Error
object
errors
One of:
string
Examplegenerated
{
"errors": {}
}