FieldMetadataResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/twenty/json-schema/twenty-field-metadata-response-schema.json",
  "title": "FieldMetadataResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/twenty-fields-api-openapi.yml#/components/schemas/FieldMetadataResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "field": {
          "$ref": "#/$defs/FieldMetadata"
        }
      }
    }
  },
  "$defs": {
    "FieldMetadata": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "readOnly": true
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "objectMetadataId": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string",
          "description": "Camel-case field name"
        },
        "label": {
          "type": "string",
          "description": "Human-readable field label"
        },
        "type": {
          "type": "string",
          "enum": [
            "TEXT",
            "RICH_TEXT",
            "NUMERIC",
            "NUMBER",
            "BOOLEAN",
            "DATE",
            "DATE_TIME",
            "SELECT",
            "MULTI_SELECT",
            "RELATION",
            "CURRENCY",
            "FULL_NAME",
            "EMAILS",
            "PHONES",
            "LINKS",
            "ADDRESS",
            "RATING",
            "UUID",
            "JSON",
            "ARRAY",
            "TS_VECTOR"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "icon": {
          "type": [
            "string",
            "null"
          ]
        },
        "isNullable": {
          "type": "boolean"
        },
        "isCustom": {
          "type": "boolean",
          "readOnly": true
        },
        "isSystem": {
          "type": "boolean",
          "readOnly": true
        },
        "isActive": {
          "type": "boolean"
        },
        "defaultValue": {},
        "options": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "color": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}