# GET /api/v2/notes

List notes

- MCP id: notes.index
- Scope: api:read:project_drive
- Scope: api:read:customer_drive
- Scope: api:read:organization_drive
- Scope: api:read:user_drive
- Permission: project_drive::access
- Rate cost: 1 unit, read bucket. `view=detail` makes it 3. Adds: `with_total=1` +2, each include +1.
- Cache-Control: private, no-store

Returns the notes whose parent record the caller may read, oldest position first.

A note is visible exactly when the record it hangs off is: only notes on projects, customers and work items you can see are listed, so this collection can be read across the whole organisation without leaking a record the caller cannot open. Scope it to one record with the `notable_type`/`notable_id` pair, which must be sent together. `total` is omitted unless you pass `with_total=1`. The declared permission is `project_drive::access`; the other three drive prefixes (`customer_drive`, `organization_drive`, `user_drive`) apply by owner type, and a token covering any of the four is accepted.

## Parameters
- view (string, optional): Which field set to render.
- per_page (integer 1 to 100, optional): Rows per page. At most 25 when `include` names a to-many relation; a larger value is 400 invalid-query-parameter.
- cursor (string, optional): Opaque keyset cursor from a previous page's links.next. Never construct one by hand.
- with_total (boolean, optional): Whether meta.page.total is counted for this request.
- filter[created_at] (timestamp (YYYY-MM-DDThh:mm:ssZ), optional): Creation timestamp. Pair with `sort=id` for a stable full export. Operators: = gte lt.
- filter[notable_id] (integer, optional): Id of the record the note is attached to, within the `notable_type` given. Must be sent together with `notable_type`. Operators: = in.
- filter[notable_type] (string, optional): Type of record the note is attached to: `project`, `customer` or `work_item`. Must be sent together with `notable_id`.
- filter[updated_at] (timestamp (YYYY-MM-DDThh:mm:ssZ), optional): Last-write timestamp. Use for incremental sync. Operators: = gte lt.
- filter[user_id] (integer, optional): Author of the note. Accepts the literal `me`. Operators: = in null.
- sort (string, optional): Up to three keys, comma-separated, each optionally prefixed with `-` for descending.
- include (string, optional): Comma-separated names to inline, at most five.
- X-Request-Id (header, optional): 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-Match (header, optional): The ETag a read is conditional on. A match is answered 304 with no body.

## Response 200
- id (integer, required): Unique identifier.
- content (html, required): Note body as rich-text HTML, sanitised on read.
- order_column (integer, required, server-assigned): 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.
- user_id (integer or null, required, server-assigned): Author of the note. Always the authenticated user at create time; `null` where the author has since been deleted.
- created_at (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Creation timestamp.
- updated_at (timestamp (YYYY-MM-DDThh:mm:ssZ), required): Last-write timestamp; use for incremental sync.
- notable_type (string, required): The kind of record `notable` points at; it says which branch of `notable` applies.
- notable_id (integer, required): The id of the record `notable` points at.
- notable (Ref or ProjectSummary or CustomerSummary or WorkItemSummary, required): The project, customer or work item this note is attached to.
- user (Ref or UserSummary or null, required): Author of the note.
- links (NoteLinks, required)
  - self (url, required): The canonical URI of this record.

## Errors
- 403 forbidden-by-policy | insufficient-permission | insufficient-token-scope: Forbidden.
- 304 : Not modified.
- 400 idempotency-key-required | invalid-cursor | invalid-query-parameter | malformed-request | unsupported-parameter: Bad request.
- 401 token-expired | unauthenticated: Unauthenticated.
- 404 endpoint-not-found | resource-not-found: Not found.
- 406 not-acceptable: Not acceptable.
- 429 rate-limit-exceeded: Too many requests.
- 500 internal-error: Server error.
- 503 tenant-unavailable: Service unavailable.

## Example
```bash
curl -G \
  'https://<your-url>/api/v2/notes' \
  --data-urlencode 'filter[notable_type]=project' \
  --data-urlencode 'filter[notable_id]=1' \
  --data-urlencode 'include=user' \
  --data-urlencode 'with_total=1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'
```