Skip to content
aimrack

Note

The note resource.

Base/note
GET/note

List notes

Retrieve a paginated list of notes. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/note
curl --request GET \
  --url '<your-host>/note?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "documentId": "xyz789",
    "note": "string",
    "noteRichText": "string",
    "active": true,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]
GET/note

Retrieve a note

Fetch a single note by filtering on `id`.

Query parameters

idstring

Match on the note's `id`, e.g. `eq.{id}`.

GET/note
curl --request GET \
  --url '<your-host>/note?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "documentId": "xyz789",
  "note": "string",
  "noteRichText": "string",
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
POST/note

Create a note

Create a new note.

Body parameters

documentIdstringrequired
notestringrequired
noteRichTextobjectrequired
activebooleanrequired
companyIdstringrequired

References company.id

POST/note
curl --request POST \
  --url <your-host>/note \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"documentId":"xyz789","note":"string","noteRichText":"string","active":true,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "documentId": "xyz789",
  "note": "string",
  "noteRichText": "string",
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
PATCH/note

Update a note

Update an existing note, matched on `id`.

Body parameters

documentIdstringrequired
notestringrequired
noteRichTextobjectrequired
activebooleanrequired
companyIdstringrequired

References company.id

PATCH/note
curl --request PATCH \
  --url '<your-host>/note?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"documentId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "documentId": "xyz789",
  "note": "string",
  "noteRichText": "string",
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
DELETE/note

Delete a note

Delete a note, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the note to delete, e.g. `eq.{id}`.

DELETE/note
curl --request DELETE \
  --url '<your-host>/note?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content