Skip to main content
GET
Get a note

Authorizations

Authorization
string
header
required

An API key from the web app (Settings → Developer), sent as Authorization: Bearer rvl_live_….

Path Parameters

noteId
string
required

Note id, note_….

Query Parameters

format
enum<string>
default:markdown

markdown (default) or html. Notes are stored as HTML from the web app's editor. Markdown is converted both ways; it drops colours, font sizes, alignment and merged table cells. HTML is sanitised to what the editor itself produces.

Available options:
markdown,
html

Response

OK

id
string
required

Note id, note_….

title
string
required
folder
object | null
required

The folder it is in.

project
object | null
required

The project it is linked to, directly or through its folder.

owner
object | null
required

Its author, or for early notes with none, its folder's owner.

access
enum<string>
required

What you can do. owner: everything, including delete and share. write: edit. read: read.

Available options:
owner,
write,
read
createdAt
string<date-time>
required
updatedAt
string<date-time>
required

Send this back as expectedUpdatedAt to replace the body.

format
enum<string>
required
Available options:
markdown,
html
content
string
required

The body, in format. Notes written before the rich editor are plain text in either format.