*MCP › Reference › Platform › 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.

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.

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

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `applyAt` | string | No | Filter by the entity the field applies to: returns only the definitions usable on that resource type. `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`.

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique identifier of the definition. It is the one used when writing a value. |
| `name` | string | Display name of the field. |
| `dataType` | string | Data type the field accepts. `text`, `multitext`, `dropdown`, `checkbox`, `radio`, `date`, `contact`, `item`, `space`, `staff_member`, `vehicle` |
| `description` | string | Field description; null if it has none. |
| `options` | string[] | Allowed values when the field is a dropdown. Empty for the other types. |
| `applyAt` | string[] | Entities the field can be used on. `order`, `item`, `space`, `contact`, `project`, `kit`, `orderTemplate`, `repairTicket`, `serializedItem`, `vehicle`, `staff`, `service`, `purchaseOrder`, `incident`, `opportunity`, `document`, `all` |
| `showOn` | string[] | Documents the field is printed on. `quote`, `proforma`, `invoice`, `contract`, `packing_slip`, `purchase_order`, `repair_ticket`, `all` |
| `isActive` | boolean | true if the definition is active and can be used. |
| `createdAt` | string<date-time> | Creation date in ISO 8601 UTC; null if not recorded. |
| `updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC; null if not recorded. |

*Call · filmo_custom_fields_list*

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

*Result (generated from the schema)*

```json
{
  "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
      }
    }
  }
}
```

## The same operation by REST

This tool runs [`GET /api/v1/custom-fields`](https://docs.filmo.io/rest-api/endpoint-reference/custom-fields/list-custom-field-definitions).

---

Canonical URL: https://docs.filmo.io/mcp/tools/custom-fields/filmo-custom-fields-list  
Last updated: 2026-10-25