---
title: "List Notes"
method: GET
path: "/api/notes"
tags: ["Notes"]
---

# List Notes

`GET /api/notes`

## Request

- Base URL: `https://keep.md`
- URL: `https://keep.md/api/notes`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `keep.session_token`

List Notes.

## Query parameters

- `includeArchived` boolean
- `include` 'content'
- `limit` integer
- `offset` integer

## Headers

- `Keep-API-Version` string

## Response `200`

Notes

- object
  - `notes` union[], required
    - union
      - NoteSummary
        - `id` string, required
        - `title` string, required
        - `currentRevision` integer, required
        - `tags` NoteTag[], required
          - `id` string, required
          - `name` string, required
          - `slug` string, required
        - `tagsTruncated` boolean, required
        - `project` object, nullable
        - `kind` string, nullable
        - `state` string, nullable
        - `content` object, required
          - `available` boolean, required
          - `bytes` integer, required
          - `lines` integer, required
        - `createdAt` integer
        - `updatedAt` integer, required
        - `archivedAt` integer, nullable
      - Note
        - `id` string, required
        - `title` string, required
        - `bodyMarkdown` string, required
        - `properties` object, required
        - `tags` NoteTag[], required
          - `id` string, required
          - `name` string, required
          - `slug` string, required
        - `project` Project
          - `id` string, required
          - `name` string, required
          - `slug` string, required
          - `description` string
          - `color` string
          - `state` 'active' | 'paused' | 'completed', required
          - `repositories` ProjectRepository[], required
            - `id` string, required
            - `provider` string, required
            - `url` string, uri, required
            - `owner` string
            - `name` string
            - `defaultBranch` string
          - `noteCount` integer, required
          - `itemCount` integer, required
          - `createdAt` integer, required
          - `updatedAt` integer, required
          - `archivedAt` integer, nullable
        - `kind` string, nullable
        - `state` string, nullable
        - `currentRevision` integer, required
        - `createdAt` integer, required
        - `updatedAt` integer, required
        - `archivedAt` integer, nullable

## Other responses

- `400`: Invalid request
- `401`: Authentication required
- `403`: The credential lacks access or the plan does not include the feature

---

[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)
