# Note

A free-text note attached to a project, a customer or a work item: the running commentary plnnrly shows in a record's Notes sub-page. The body is rich text from the editor, sanitised on the way out. A note is read through the record it hangs off, and written under that record's own note permission: `projects::notes`, `customers::update` or `project_management::manage_work_items` by parent type.

## Used by
- GET /api/v2/notes: List notes (NoteList)
- POST /api/v2/notes: Create a note (Note)
- GET /api/v2/notes/{note}: Read a note (Note)
- PATCH /api/v2/notes/{note}: Update a note (Note)

## Note fields
- 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.

## Variants

### NoteList

What a collection returns, and what `?view=summary` returns on a single record.

11 fields.
Identical to the detail object above.

### NoteLinks

The `links` object on this resource.

Keys: self

## Polymorphic fields
- notable: discriminated on `notable_type`

## Example
```json
{
  "id": 1,
  "content": "<p>Kick-off moved to Monday; the client will confirm scope by Friday.</p>",
  "order_column": 1,
  "user_id": 1,
  "created_at": "2026-03-04T09:15:00Z",
  "updated_at": "2026-03-04T09:15:00Z",
  "notable_type": "project",
  "notable_id": 1,
  "notable": {
    "id": 1
  },
  "user": null,
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1"
  }
}
```