List every frontmatter field in the vault
GET
/fields
const url = 'https://api.engram.page/fields';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.engram.page/fields \ --header 'Authorization: Bearer <token>'Returns every frontmatter field the vault’s indexed notes use: its name (the key of a search fields filter), value kinds, how many live notes carry it, whether a note holds a list of values, the number or date range, and the 50 most used exact values with note counts. Most used fields first. Derived from the index, so a note’s fields appear once it has been indexed. filterable says whether search accepts fields filters on this server yet.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Fields
Media typeapplication/json
FieldsResponse
object
fields
required
Array<object>
object
date_range
required
Earliest and latest ISO date or datetime (UTC), or null
object
max
required
string
min
required
string
kinds
required
Array<string>
list
required
Some note holds several values
boolean
name
required
The key a search fields filter takes
string
note_count
required
Live notes carrying the field
integer
number_range
required
Smallest and largest number, or null
object
max
required
number
min
required
number
values
required
Most used exact values (at most 50), most notes first
Array<object>
object
count
required
integer
value
required
string
filterable
required
Whether search accepts fields filters on this server yet
boolean
Example
{ "fields": [ { "date_range": null, "kinds": [ "string" ], "list": false, "name": "status", "note_count": 42, "number_range": null, "values": [ { "count": 30, "value": "draft" }, { "count": 12, "value": "done" } ] }, { "date_range": null, "kinds": [ "number" ], "list": false, "name": "priority", "note_count": 17, "number_range": { "max": 5, "min": 1 }, "values": [] }, { "date_range": { "max": "2026-12-15", "min": "2026-09-01" }, "kinds": [ "date" ], "list": false, "name": "due", "note_count": 9, "number_range": null, "values": [] } ], "filterable": true}