Notes

List the notes of an entity

Returns the notes attached to ONE entity of the account, newest first.

Tool

filmo_notes_list

Readnotes:read

notes:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_notes_list",
    "arguments": {
      "relatedDocumentType": "item",
      "relatedDocumentId": "rela_8f2a1c",
      "limit": 20
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "content": "<content>",
        "relatedDocumentType": "<relatedDocumentType>",
        "relatedDocumentId": "rela_8f2a1c",
        "subRelatedDocumentType": "<subRelatedDocumentType>",
        "subRelatedDocumentId": "subr_8f2a1c",
        "subRelatedDocumentCode": "<subRelatedDocumentCode>",
        "createdAt": "2026-09-01T08:00:00Z",
        "updatedAt": "2026-09-01T08:00:00Z"
      }
    ],
    "pagination": {
      "nextCursor": "eyJvIjo1MH0",
      "hasMore": true,
      "total": 1
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

relatedDocumentType and relatedDocumentId are required — there is no listing of all the notes — and the entity must belong to the account: otherwise it responds 404 without reading anything.

Arguments

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.

Limits: max length 200

relatedDocumentTypestringRequired

Type of the entity whose notes are listed. Required.

Available options: item, contact, order, space, kit, vehicle, staff, service, collection, project, repairTicket, purchaseOrder, supplierInvoice

relatedDocumentIdstringRequired

Identifier of that entity. Required; it must belong to the account.

Limits: min length 1

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

dateFiltersobject

Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, updated.

Show child attributes

dateFilters.createdobject

Show child attributes

dateFilters.created.gtestring

From this day or instant, inclusive.

dateFilters.created.ltestring

Up to this day or instant, inclusive.

dateFilters.created.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.created.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.created.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.updatedobject

Show child attributes

dateFilters.updated.gtestring

From this day or instant, inclusive.

dateFilters.updated.ltestring

Up to this day or instant, inclusive.

dateFilters.updated.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.updated.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.updated.onstring

Exactly that day; an instant means the whole business day that contains it.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique identifier of the note.

contentstring

Note text.

relatedDocumentTypestring | null

Type of the entity the note is attached to; null if it is not attached.

relatedDocumentIdstring | null

Identifier of that entity; null if the note is not attached.

subRelatedDocumentTypestring | null

Type of the sub-entity; null if not applicable.

subRelatedDocumentIdstring | null

Identifier of the sub-entity; null if not applicable.

subRelatedDocumentCodestring | null

Human-readable code of the sub-entity; null if not applicable.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/notes.

Notes
List the notes of an entity
Returns the notes attached to ONE entity of the account, newest first.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

List the notes of an entity

Safe writes

Errors