メインコンテンツへスキップ
GET
/
forms
/
v2
/
fields
/
{form_guid}
Get all fields from a form
curl --request GET \
  --url https://api.hubapi.com/forms/v2/fields/{form_guid}
[
  {
    "name": "<string>",
    "label": "<string>",
    "type": "<string>",
    "fieldType": "<string>",
    "description": "<string>",
    "groupName": "<string>",
    "displayOrder": 123,
    "required": true,
    "selectedOptions": [
      "<string>"
    ],
    "options": [
      {}
    ],
    "validation": {
      "name": "<string>",
      "message": "<string>",
      "data": "<string>",
      "useDefaultBlockList": true,
      "blockedEmailAddresses": [
        "<string>"
      ]
    },
    "enabled": true,
    "hidden": true,
    "defaultValue": "<string>",
    "isSmartField": true,
    "unselectedLabel": "<string>",
    "placeholder": "<string>",
    "dependentFieldFilters": [
      {}
    ],
    "labelHidden": true,
    "propertyObjectType": "<string>",
    "metaData": [
      {}
    ],
    "objectTypeId": "<string>"
  }
]

パスパラメータ

form_guid
string
必須

The ID of the form you're requesting.

レスポンス

Form fields retrieved successfully

name
string
必須

The name of the field

label
string
必須

The label of the field

type
string
必須

The type of the field

fieldType
string
必須

The field type

description
string

The description of the field

groupName
string

The group name

displayOrder
integer

The display order

required
boolean

Whether the field is required

selectedOptions
string[]
options
object[]
validation
object
enabled
boolean

Whether the field is enabled

hidden
boolean

Whether the field is hidden

defaultValue
string

The default value

isSmartField
boolean

Whether this is a smart field

unselectedLabel
string

The unselected label

placeholder
string

The placeholder text

dependentFieldFilters
object[]
labelHidden
boolean

Whether the label is hidden

propertyObjectType
string

The property object type

metaData
object[]
objectTypeId
string

The object type ID

Last modified on April 13, 2026