freshworks · Schema

Field

Properties

Name	Type	Description
id	integer	Unique ID of the field.
name	string	Internal name of the field.
label	string	Display label.
field_type	string	Type of field (text, dropdown, checkbox, etc).
required	boolean	Whether the field is required.
position	integer	Display position order.
choices	array	Available choices for dropdown fields.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Field",
  "title": "Field",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique ID of the field."
    },
    "name": {
      "type": "string",
      "description": "Internal name of the field."
    },
    "label": {
      "type": "string",
      "description": "Display label."
    },
    "field_type": {
      "type": "string",
      "description": "Type of field (text, dropdown, checkbox, etc)."
    },
    "required": {
      "type": "boolean",
      "description": "Whether the field is required."
    },
    "position": {
      "type": "integer",
      "description": "Display position order."
    },
    "choices": {
      "type": "array",
      "description": "Available choices for dropdown fields.",
      "items": {
        "type": "string"
      }
    }
  }
}