Read a note
GEThttps://
Returns one note in the detail view.
Access
- Token scope
- api:
read: orapi:project_drive read: orapi:customer_drive read: orapi:organization_drive read: user_drive Without it:
403 insufficient-token-scope. - Permission
- project_drive::
access Without it:
403 insufficient-permission. - Rate cost
- 1 unit, read bucket.
- Also
If-None-Matchanswers304when 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
Query parameters
Unknown parameters are refused with 400, naming the parameter.
Request headers
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.
Response 200
Returns a Note in the detail view.
Headers
ETag- A strong validator of exactly this representation.
RateLimit- The IETF
httpapi-ratelimit-headersform 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
Sort position within the parent record. Assigned by the server; reordering is not exposed in v2.0. Positions are not counted per parent, so the sequence is effectively creation order across the whole organisation.
Author of the note. Always the authenticated user at create time; null where the author has since been deleted.
The kind of record notable points at; it says which branch of notable applies.
projectcustomerwork_item
New values may be added.
The project, customer or work item this note is attached to.
Which form you get depends on notable_type.
projectProjectSummarycustomerCustomerSummarywork_itemWorkItemSummary
Author of the note.
Errors
8 errors every operation can return: 304, 400, 401, 404, 406, 429, 500, 503
304 Not modified.
400 Bad request.
idempotency-key-requiredinvalid-cursorinvalid-query-parametermalformed-requestunsupported-parameter
401 Unauthenticated.
404 Not found.
406 Not acceptable.
429 Too many requests.
500 Server error.
503 Service unavailable.
This path allows GET, PATCH, DELETE. Anything else answers 405.
Something wrong or missing on this page? Tell us