Skip to content

Notes API

All endpoints require authentication as the listing owner. Notes are nested under listings.

GET /listings/:id/notes

List notes for a listing.

Response (200)

json
{
  "notes": [
    {
      "id": "uuid",
      "content": "Tenant moving out March 31",
      "createdAt": "2026-03-02T00:00:00.000Z",
      "updatedAt": "2026-03-02T00:00:00.000Z"
    }
  ]
}

POST /listings/:id/notes

Add a note to a listing.

Body

json
{
  "content": "Tenant moving out March 31"
}

Response (201)

json
{
  "note": {
    "id": "uuid",
    "content": "Tenant moving out March 31",
    "createdAt": "2026-03-02T00:00:00.000Z",
    "updatedAt": "2026-03-02T00:00:00.000Z"
  }
}

PUT /listings/:id/notes/:noteId

Edit a note.

Body

json
{
  "content": "Updated note content"
}

Response (200)

json
{
  "success": true
}

DELETE /listings/:id/notes/:noteId

Delete a note.

Response (200)

json
{
  "success": true
}