*API REST › Referencia de endpoints › Plataforma › Campos personalizados*

# Listar definiciones de campos personalizados

> Devuelve las DEFINICIONES de los campos personalizados de la cuenta: qué identificador tiene cada uno, qué tipo admite y, si es un desplegable, qué valores acepta.

Te permite identificar un campo personalizado y los valores que acepta. La v1 solo lee campos personalizados: ningún cuerpo de creación o actualización los admite, así que se establecen en la aplicación de Filmo. No devuelve el valor asignado a ninguna entidad: los valores viajan dentro de cada recurso.

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

Permiso: `custom-fields:read` · 120/min · Complemento (402) · MCP: `filmo_custom_fields_list`

## Autorizaciones

Clave de API como Bearer, con el permiso de abajo. `custom-fields:read`

## Parámetros de consulta

| Nombre | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- |
| `applyAt` | string | No | Filtra por la entidad a la que se aplica el campo: devuelve solo las definiciones utilizables en ese tipo de recurso. `order`, `item`, `space`, `contact`, `project`, `kit`, `orderTemplate`, `repairTicket`, `serializedItem`, `vehicle`, `staff`, `service`, `purchaseOrder`, `incident`, `opportunity`, `document`, `all` |

## Ejemplos de petición

*Listar definiciones de campos personalizados*

**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"
    }
)
```

## Respuesta

Esquema de la respuesta: `CustomFieldDefinitionDto`

| Estado | Descripción |
| --- | --- |
| 200 | Respuesta correcta. |
| 400 | Petición no válida (validation_error): consulta o cuerpo mal formados. `errors[]` enumera cada campo erróneo con su código estable. |
| 401 | Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 402 | Add-on requerido (addon_required): el plan de la cuenta no incluye el add-on que necesita esta operación; `requiredAddon` lo nombra. |
| 403 | No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en `requiredScope`; forbidden: el propietario de la clave carece del permiso que exige la operación). `insufficient_scope` se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras `RateLimit-*`; `forbidden` sí. |
| 429 | Límite de peticiones superado (rate_limited): reintenta tras `Retry-After` segundos; `RateLimit-*` indica qué cuota se ha agotado. |
| 500 | Error interno (internal_error). |

**200**

| Nombre | Tipo | Descripción |
| --- | --- | --- |
| `data` | object[] |  |
| `data.id` | string | Identificador único de la definición. Es el que se usa al escribir un valor. |
| `data.name` | string | Nombre visible del campo. |
| `data.dataType` | string | Tipo de dato que acepta el campo. `text`, `multitext`, `dropdown`, `checkbox`, `radio`, `date`, `contact`, `item`, `space`, `staff_member`, `vehicle` |
| `data.description` | string | Descripción del campo; null si no tiene. |
| `data.options` | string[] | Valores permitidos cuando el campo es un desplegable. Vacío para los demás tipos. |
| `data.applyAt` | string[] | Entidades en las que se puede usar el campo. `order`, `item`, `space`, `contact`, `project`, `kit`, `orderTemplate`, `repairTicket`, `serializedItem`, `vehicle`, `staff`, `service`, `purchaseOrder`, `incident`, `opportunity`, `document`, `all` |
| `data.showOn` | string[] | Documentos en los que se imprime el campo. `quote`, `proforma`, `invoice`, `contract`, `packing_slip`, `purchase_order`, `repair_ticket`, `all` |
| `data.isActive` | boolean | true si la definición está activa y se puede usar. |
| `data.createdAt` | string<date-time> | Fecha de creación en ISO 8601 UTC; null si no consta. |
| `data.updatedAt` | string<date-time> | Fecha de la última modificación en ISO 8601 UTC; null si no está registrada. |
| `meta` | object | Información adicional sobre la respuesta. |
| `meta.warnings` | object[] | Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta. |
| `meta.warnings.code` | string | Código de aviso estable. `deprecated` |
| `meta.warnings.message` | string | Para personas: qué está obsoleto, hasta cuándo y qué usar. |
| `meta.warnings.sunset` | string | Día (YYYY-MM-DD) en que la operación deja de estar disponible. |
| `meta.warnings.replacement` | string | `operationId` de la operación que hay que usar en su lugar, o null si no hay ninguna. |
| `meta.warnings.link` | string | Dónde está documentada la deprecación (el changelog). |

*Respuesta de ejemplo · 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"
    }
  ]
}
```

## Errores

| Estado | Códigos | Significado |
| --- | --- | --- |
| 400 | `validation_error` | Consulta o cuerpo mal formados. `errors[]` enumera cada campo erróneo con su código estable. |
| 402 | `addon_required` | El plan de la cuenta no incluye el add-on que necesita esta operación; `requiredAddon` lo nombra. |

## Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada.

---

URL canónica: https://docs.filmo.io/es/rest-api/endpoint-reference/custom-fields/list-custom-field-definitions  
Última actualización: 2026-10-25