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.

GET
/api/v1/custom-fields

Ejemplos de petición

curl https://app.filmo.io/api/v1/custom-fields \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "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"
    }
  ]
}

Generado a partir del esquema

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.

Autorizaciones

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

Parámetros de consulta

applyAtstring

Filtra por la entidad a la que se aplica el campo: devuelve solo las definiciones utilizables en ese tipo de recurso.

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

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: CustomFieldDefinitionDto

Sobre: CustomFieldDefinitionItems. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Mostrar atributos hijos
data.idstring

Identificador único de la definición. Es el que se usa al escribir un valor.

data.namestring

Nombre visible del campo.

data.dataTypestring

Tipo de dato que acepta el campo.

Opciones disponibles: text, multitext, dropdown, checkbox, radio, date, contact, item, space, staff_member, vehicle

data.descriptionstring | null

Descripción del campo; null si no tiene.

data.optionsstring[]

Valores permitidos cuando el campo es un desplegable. Vacío para los demás tipos.

data.applyAtstring[]

Entidades en las que se puede usar el campo.

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

data.showOnstring[]

Documentos en los que se imprime el campo.

Opciones disponibles: quote, proforma, invoice, contract, packing_slip, purchase_order, repair_ticket, all

data.isActiveboolean

true si la definición está activa y se puede usar.

data.createdAtstring<date-time> | null

Fecha de creación en ISO 8601 UTC; null si no consta.

data.updatedAtstring<date-time> | null

Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
402addon_requiredEl plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

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