Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

GET/notes/{note}

Read a note

GEThttps://<your-url>/api/v2/notes/{note}

MCP id notes.showAlso on this path: PATCH Update a note, DELETE Delete a note

View as Markdown openapi.json

Returns one note in the detail view.

Access

Permission
project_drive::access

Without it: 403 insufficient-permission.

Rate cost
1 unit, read bucket.
Also
If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

The summary and detail payloads are identical on this resource: the body is rendered in both, because plnnrly shows note bodies inline in its list. notable and user render as {"id": N} references until named in include. There is no soft delete: a deleted note is gone, and trashed is not an accepted parameter. The declared permission is project_drive::access; the other three drive prefixes apply by owner type, and whether you can see the parent record is what actually decides.

Path parameters

noteintegerRequired

The Note's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a Note in the detail view.

Headers

ETag
A strong validator of exactly this representation.
RateLimit
The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy
The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id
The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

Errors

8 errors every operation can return: 304, 400, 401, 404, 406, 429, 500, 503

This path allows GET, PATCH, DELETE. Anything else answers 405.