API v1
v1
View as Markdown

List the notes of a vault

GET /api/v1/vaults/{vault}/knowledge/notes

List the notes of a vault's Knowledge by title, without their text.

A note can be long, so the list leaves its text out. Read one note to get it.

This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.

Parameters

Sent as JSON. Anything not listed here is ignored.

vault string Required

The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.

folder uuid Optional

Only the notes of this folder. The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404.

Returns

Every knowledge note object of the vault, without its text, or an empty list. A vault of another account answers 404.

data array

Every note, whole rather than a page at a time.

data[] object

One knowledge note, without its text.

data[].type string

Always knowledge_note.

data[].id string

The id of the note, which every address naming it takes.

data[].attributes object

What the note is, without its text.

data[].attributes.title string

The title of the note.

data[].attributes.folder object

The folder the note sits in.

data[].attributes.folder.id uuid

The id of the folder, as the knowledge folders endpoints give it.

data[].attributes.folder.name string

What the folder is called.

data[].attributes.created_at timestamp

When the note was written, as a count of seconds since 1970.

data[].attributes.updated_at timestamp

When it last changed, as a count of seconds, or null.

data[].links object

Where to find this note.

data[].links.self string

The absolute address the whole note is read from.

data[].links.web string

The note in the application, which opens for somebody signed in rather than for a key. It is the link to give a person.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

GET
curl https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes');
Response 200
{
"data": [
{
"type": "knowledge_note",
"id": "7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
"attributes": {
"title": "Dundies speech",
"folder": {
"id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
"name": "Office"
},
"created_at": 1773331200,
"updated_at": 1773417600
},
"links": {
"self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92",
"web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/7a2d9e4f-1c63-4b85-9f07-3e6c8a1d5b92"
}
},
{
"type": "knowledge_note",
"id": "4c8e2a61-9b37-4d05-a6f1-0e3b7c9d2a58",
"attributes": {
"title": "Fire drill",
"folder": {
"id": "2b7e4c91-0d5a-4f38-9c16-8e3a7f1b5d24",
"name": "Office"
},
"created_at": 1773504000,
"updated_at": 1773504000
},
"links": {
"self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/knowledge/notes/4c8e2a61-9b37-4d05-a6f1-0e3b7c9d2a58",
"web": "https://my.monicahq.com/vaults/dunder-mifflin/knowledge/notes/4c8e2a61-9b37-4d05-a6f1-0e3b7c9d2a58"
}
}
]
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.