---
title: "Read a Note overview, line range, or search window"
method: GET
path: "/api/notes/{id}/read"
tags: ["Notes"]
---

# 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`

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

## Path parameters

- `id` string, required

## Query parameters

- `view` 'overview' | 'lines' | 'search'
- `revision` integer
- `includeArchived` boolean
- `headingLimit` integer
- `lines` string
- `q` string
- `contextLines` integer
- `limit` integer

## Headers

- `Keep-API-Version` string

## Response `200`

Bounded Note read

- object: 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.

## Other responses

- `400`: Invalid request
- `401`: Authentication required
- `403`: The credential lacks access or the plan does not include the feature
- `404`: Resource not found
- `413`: The requested exact line slice exceeds 32000 UTF-8 bytes. Request a narrower range.
- `416`: Requested lines are outside the Note

---

[API](https://skmtc.dev/keep/apis/keep-api.md) · [All operations](https://skmtc.dev/keep/apis/keep-api/llms.txt) · [OpenAPI document](https://skmtc.dev/keep/apis/keep-api/revisions/a338a455bd0f?raw)