*REST API › Endpoint 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.

`GET /api/v1/custom-fields` — scope `custom-fields:read`

Scope: `custom-fields:read` · 120/min · Add-on (402) · MCP: `filmo_custom_fields_list`

## Authorizations

Bearer API key with the scope below. `custom-fields:read`

## Query parameters

| 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` |

## Request examples

*List custom field definitions*

**cURL**

```bash
curl https://app.filmo.io/api/v1/custom-fields \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/custom-fields', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get(
    "https://app.filmo.io/api/v1/custom-fields",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `CustomFieldDefinitionDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 402 | Add-on required (addon_required): the account plan does not include the add-on this operation needs; `requiredAddon` names it. |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object[] |  |
| `data.id` | string | Unique identifier of the definition. It is the one used when writing a value. |
| `data.name` | string | Display name of the field. |
| `data.dataType` | string | Data type the field accepts. `text`, `multitext`, `dropdown`, `checkbox`, `radio`, `date`, `contact`, `item`, `space`, `staff_member`, `vehicle` |
| `data.description` | string | Field description; null if it has none. |
| `data.options` | string[] | Allowed values when the field is a dropdown. Empty for the other types. |
| `data.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` |
| `data.showOn` | string[] | Documents the field is printed on. `quote`, `proforma`, `invoice`, `contract`, `packing_slip`, `purchase_order`, `repair_ticket`, `all` |
| `data.isActive` | boolean | true if the definition is active and can be used. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 UTC; null if not recorded. |
| `data.updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC; null if not recorded. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": [
    {
      "id": "custom_field_definition_9f3a2b",
      "name": "Example custom field definition",
      "dataType": "text",
      "description": "Example text.",
      "options": [
        "Example options"
      ],
      "applyAt": [
        "order"
      ],
      "showOn": [
        "quote"
      ],
      "isActive": true,
      "createdAt": "2026-09-01T08:00:00.000Z",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ]
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 402 | `addon_required` | The account plan does not include the add-on this operation needs; `requiredAddon` names it. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/custom-fields/list-custom-field-definitions  
Last updated: 2026-10-25