Skip to content

The REST API and MCP server are Pro features that let you query and manage your notes from scripts, automation pipelines, and AI assistants like Claude or Cursor — without ever opening the browser. From Claude Desktop you can also share notes publicly using natural language — the same zero-knowledge guarantee applies.

Getting an API Key

Go to Settings → API & Data and click Generate key. Keys have the format sqn_ followed by 64 hex characters — for example, sqn_a1b2c3d4….

Copy it immediately. The raw key is shown once at generation and cannot be retrieved again. You can regenerate a key at any time (which invalidates the old one) or revoke it entirely.

The same key authenticates both the REST API and the MCP server.

Public REST API

The API base URL is https://api.squirrelnotes.app. Authenticate every request with:

Authorization: Bearer sqn_<your_api_key>

A missing, wrong, revoked or rotated key gets 401 Unauthorized with the message "Invalid API key". A valid key on an account that is no longer Pro gets 403 Forbidden with "API access requires a Pro subscription".

Monthly API calls

Each request made with your API key counts as one call, including the requests an AI agent's tools make through the MCP server (one tool can make several). Pro includes 5,000 calls a month. The count resets on the 1st of each month at 00:00 UTC.

You can see how many you've used above Storage at the bottom of the library panel and of Settings, at the bottom of the library on your phone (tap Usage to show it), and in Settings › API & Data. The bar turns amber at 80% and red at 100%, and on a phone the Usage button says Usage high or Over limit even while the bar is hidden.

The limit isn't enforced yet. Calls over 5,000 still work, and the app shows how far over you are. We'll tell you in the app and by email before it is. Once it is, a call over the limit gets 429 Too Many Requests with the message "Monthly API call limit reached", the limit, the time it resets (resetsAt) and a Retry-After header; nothing is read or written. The MCP server tells your agent that the month's calls are used up and when they resume, and keeps your key.

What does not count: a request refused for a bad key or a lapsed Pro plan, the interactive docs, public links opened by anyone, and everything the app itself does.

Because Squirrel Notes is end-to-end encrypted, the API deals in ciphertext. Your client must encrypt content with your passphrase-derived key before sending it, and decrypt after receiving. The server never sees plaintext.

Interactive docs are available at api.squirrelnotes.app/public/docs. The API covers:

  • Notes — create, read, update, pin, tag, move between collections, and the Trash (delete, restore, delete permanently, empty)
  • Collections — full CRUD, including nested hierarchies
  • Tags — full CRUD with colour support
  • Saved Searches — save and manage reusable search queries
  • Templates — your custom templates
  • Sharing — publish, check, update, republish and revoke public links
  • Attachments — list, upload, download and delete
  • Memory — list, read, add, update and supersede memories, and read their change history (GET /public/memory/history). There is no delete route: only you can delete a memory, in the app
  • Activity — your account's activity log (GET /public/activity): each event, the id of what it acted on, how it was made (authMethod) and the request's method, route and status; never any content. every API call the server accepts is in it too; admin-screen events are left out here