Skip to main content
GET
Read a note by slug

Authorizations

Authorization
string
header
required

Static bearer, WorkOS JWT, or open local when AUTH_REQUIRED is off and no static tokens are set. The token selects the vault; paths do not include vault_id.

Path Parameters

note
string
required
Minimum string length: 1

Query Parameters

start_line
integer
Required range: 1 <= x <= 9007199254740991
end_line
integer
Required range: 1 <= x <= 9007199254740991
cursor
integer
Required range: 1 <= x <= 9007199254740991
version_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

content_hash
string
required
end_line
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
lines
object[]
required
next_cursor
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
note_id
string
required
observed_at
string | null
required
slug
string
required
start_line
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
status
string
required
title
string | null
required
total_lines
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
truncated
boolean
required
version_id
string
required
visibility
string
required