Skip to main content
GET
Get Note Summary

Authorizations

Authorization
string
header
required

API key in format {id}.{secret}.

The notes an endpoint returns depend on the key type. A user key reaches the notes that user can see in the app, including notes in their own private folders. A system key (workspace or organization, no user identity) reaches only notes that sit in a folder shared with all workspace members. Notes in a private folder, in a folder shared with only some members, or in no folder at all fall outside a system key's read scope, and scopes do not widen that boundary.

List and search endpoints drop out-of-scope notes from the response without an error. Single-note reads and their sub-resources return 404, the same response as a deleted note. See What notes a system key reads.

Path Parameters

noteGuid
string
required

Note GUID

summaryId
integer<int64>
required

Summary ID from list endpoint

Query Parameters

format
enum<string>
default:text/markdown

Content format

Available options:
text/markdown,
text/plain

Response

Summary with full content

A single block of summary text for a Note (the "one-page" summary). A Note can have multiple NoteSummaries in different languages or templates. Unlike NoteDocument, it is not divided into sections. See Data Model.

id
integer<int64>
required

Summary ID

Example:

123

noteGuid
string
required

Associated note GUID

Example:

"note-abc123-def456"

note
object
required

Note reference with minimal information

locale
enum<string>
required

Supported language locale

Available options:
ko_KR,
en_US,
de_DE,
ja_JP,
es_ES,
fr_FR,
id_ID,
vi_VN,
tr_TR,
uk_UA,
ru_RU,
hi_IN,
it_IT,
zh_CN,
ms_MY,
th_TH,
sv_SE
Example:

"ko_KR"

content
object
required
createdAt
string<date-time>
required

Creation timestamp

Example:

"2025-12-12T12:00:00Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2025-12-12T12:05:00Z"

template
object | null

Template used for this summary. Null if the template has been deleted.