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

# List notes

`GET /notes`

## Request

- Base URL: `https://freshjots.com/api/v1`
- URL: `https://freshjots.com/api/v1/notes`
- Auth: HTTP bearer

Summaries, newest updated first by default. `q` runs the same full-text search as the app (title, filename and body; a client-encrypted body is never indexed) and ranks by relevance unless `sort` is given.

## Query parameters

- `format` 'plain' | 'rich'
- `folder_id` string
- `sort` 'updated' | 'created' | 'appended'
- `q` string
- `limit` integer
- `offset` integer

## Response `200`

The page of notes.

- NoteList
  - `notes` NoteSummary[], required
    - `id` integer, required
    - `hashid` string, required
    - `filename` string, required
    - `title` string, nullable
    - `format` 'plain' | 'rich', required
    - `folder_id` integer, nullable
    - `pinned` boolean
    - `append_only` boolean, required
    - `client_encrypted` boolean, required
    - `append_deadline_hours` integer, nullable
    - `alert_email` string, nullable
    - `match_pattern` string, nullable
    - `match_alerted_at` string, date-time, nullable
    - `last_appended_at` string, date-time, nullable
    - `alerted_at` string, date-time, nullable
    - `webhook_url` string, nullable
    - `webhook_format` 'generic' | 'slack' | 'discord' | 'google_chat' | 'mattermost' | 'rocket_chat'
    - `webhook_failure_count` integer
    - `webhook_disabled_at` string, date-time, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `plain_body_excerpt` string, required: Up to 500 characters of the body.

---

[API](https://skmtc.dev/freshjots/apis/fresh-jots-api.md) · [All operations](https://skmtc.dev/freshjots/apis/fresh-jots-api/llms.txt) · [OpenAPI document](https://skmtc.dev/freshjots/apis/fresh-jots-api/revisions/2708284fa25a?raw)