Custom fields

List custom field definitions

Returns the custom field DEFINITIONS of the account: which identifier each one has, which type it admits and, if it is a dropdown, which values it accepts.

Tool

filmo_custom_fields_list

Readcustom-fields:read

custom-fields:read
120/min
May need an add-on
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_custom_fields_list",
    "arguments": {}
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "name": "Example",
        "dataType": "text",
        "description": "<description>",
        "options": [
          "<options>"
        ],
        "applyAt": [
          "order"
        ],
        "showOn": [
          "quote"
        ],
        "isActive": true,
        "createdAt": "2026-09-01T08:00:00Z",
        "updatedAt": "2026-09-01T08:00:00Z"
      }
    ],
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

It lets you identify a custom field and the values it accepts. v1 only reads custom fields: no create or update body takes them, so they are set in the Filmo application. It does not return the value assigned to any entity: values travel inside each resource.

Arguments

applyAtstring

Filter by the entity the field applies to: returns only the definitions usable on that resource type.

Available options: order, item, space, contact, project, kit, orderTemplate, repairTicket, serializedItem, vehicle, staff, service, purchaseOrder, incident, opportunity, document, all

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 definition. It is the one used when writing a value.

namestring

Display name of the field.

dataTypestring

Data type the field accepts.

Available options: text, multitext, dropdown, checkbox, radio, date, contact, item, space, staff_member, vehicle

descriptionstring | null

Field description; null if it has none.

optionsstring[]

Allowed values when the field is a dropdown. Empty for the other types.

applyAtstring[]

Entities the field can be used on.

showOnstring[]

Documents the field is printed on.

Available options: quote, proforma, invoice, contract, packing_slip, purchase_order, repair_ticket, all

isActiveboolean

true if the definition is active and can be used.

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

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/custom-fields.

Custom fields
List custom field definitions
Returns the custom field DEFINITIONS of the account: which identifier each one has, which type it admits and, if it is a dropdown, which values it accepts.
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 custom field definitions

Safe writes

Errors