---
title: "Get VM notes"
method: GET
path: "/api/v1/vms/{id}/notes"
tags: ["Virtual Machines"]
---

# Get VM notes

`GET /api/v1/vms/{id}/notes`

Get the personal and account-shared notes attached to a VM.

- **Personal note** — visible only to the user that wrote it.
- **Account note** — visible to all members of the account.

Use the optional `type` query param to fetch only one scope. Either or both fields may be absent from the response if no note has been written yet — in that case only `{ "success": true }` is returned.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `type` 'personal' | 'account'

## Response `200`

VM notes

- VMNotesResponse — Personal and account notes for a VM. Either or both may be present.
  - `success` boolean, required
  - `personal_note` VMNote — A free-form note attached to a VM. `personal` notes are visible only to the writer; `account` notes are shared across the account.
    - `id` string, uuid, required — Note identifier.
    - `vm_id` string, uuid, required — VM this note belongs to.
    - `user_id` string, uuid, required — User who wrote the note.
    - `type` 'personal' | 'account', required — Note scope.
    - `content` string, required — Note text.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `account_note` VMNote — A free-form note attached to a VM. `personal` notes are visible only to the writer; `account` notes are shared across the account.
    - `id` string, uuid, required — Note identifier.
    - `vm_id` string, uuid, required — VM this note belongs to.
    - `user_id` string, uuid, required — User who wrote the note.
    - `type` 'personal' | 'account', required — Note scope.
    - `content` string, required — Note text.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400` — Invalid request parameters
- `401` — Authentication required
- `404` — Resource not found

---

[API](https://skmtc.net/rafftechnologies/apis/raff-api.md) · [All operations](https://skmtc.net/rafftechnologies/apis/raff-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rafftechnologies/raff-api/versions/a3f123570011/schema)