Skip to main content
GET
/
api
/
v1
/
vms
/
{id}
/
notes
Get VM notes
curl --request GET \
  --url https://api.rafftechnologies.com/api/v1/vms/{id}/notes \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "personal_note": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vm_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "account_note": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vm_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "content": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}
Updated May 8, 2026

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Each key is bound to a specific account.

Path Parameters

​
id
string<uuid>
required

VM ID (UUID)

Query Parameters

​
type
enum<string>

Filter to one note scope. Omit to return both.

Available options:
personal,
account

Response

VM notes

Personal and account notes for a VM. Either or both may be present.

​
success
boolean
required
Example:

true

​
personal_note
object

A free-form note attached to a VM. personal notes are visible only to the writer; account notes are shared across the account.

​
account_note
object

A free-form note attached to a VM. personal notes are visible only to the writer; account notes are shared across the account.

Last modified on May 8, 2026