Notes

Read a Note overview, line range, or search window

Read a Note overview, line range, or search window.

get/api/notes/{id}/read

Request

  • Base URL: https://keep.md
  • URL: https://keep.md/api/notes/{id}/read
  • Auth: one of:
    • HTTP bearer
    • API key in cookie keep.session_token

Path parameters

idstring required

Bare Note ID. Legacy IDs beginning with note_ are also accepted.

Query parameters

view'overview' | 'lines' | 'search'
revisioninteger
includeArchivedboolean
headingLimitinteger
linesstring

Required for lines view, for example 40:90. Maximum 200 lines.

qstring

Required for search view

contextLinesinteger
limitinteger

Headers

Keep-API-Versionstring
Example:2026-08-24

Optional date-based Keep API version. Omit it to use the current version.

Response

Bounded Note read

object required

Overview headings are individually capped at 300 UTF-8 bytes. Search windows total at most 200 lines and 16000 UTF-8 bytes. Exact slices contain at most 200 lines and 32000 UTF-8 bytes.

Changes

No recorded changes to this operation across all 1 revision of this API.