Skip to main content
GET
/
forms
/
v2
/
forms
Get all forms from an account
curl --request GET \
  --url https://api.hubapi.com/forms/v2/forms
[
  {
    "portalId": 123,
    "guid": "<string>",
    "name": "<string>",
    "action": "<string>",
    "method": "<string>",
    "cssClass": "<string>",
    "redirect": "<string>",
    "submitText": "<string>",
    "followUpId": "<string>",
    "notifyRecipients": "<string>",
    "leadNurturingCampaignId": "<string>",
    "formFieldGroups": [
      {
        "fields": [
          {
            "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>"
          }
        ],
        "default": true,
        "isSmartGroup": true,
        "richText": {
          "content": "<string>",
          "type": "<string>"
        },
        "isPageBreak": true
      }
    ],
    "createdAt": 123,
    "updatedAt": 123,
    "performableHtml": "<string>",
    "migratedFrom": "<string>",
    "ignoreCurrentValues": true,
    "metaData": [
      {}
    ],
    "deletable": true,
    "inlineMessage": "<string>",
    "tmsId": "<string>",
    "captchaEnabled": true,
    "campaignGuid": "<string>",
    "cloneable": true,
    "editable": true,
    "formType": "<string>",
    "deletedAt": 123,
    "themeName": "<string>",
    "parentId": 123,
    "style": "<string>",
    "isPublished": true,
    "publishAt": 123,
    "unpublishAt": 123,
    "publishedAt": 123,
    "customUid": "<string>",
    "createMarketableContact": true,
    "editVersion": 123,
    "thankYouMessageJson": "<string>",
    "themeColor": "<string>",
    "alwaysCreateNewCompany": true,
    "internalUpdatedAt": 123,
    "businessUnitId": 123,
    "portableKey": "<string>",
    "paymentSessionTemplateIds": [
      "<string>"
    ],
    "selectedExternalOptions": [
      {
        "referenceType": "<string>",
        "objectTypeId": "<string>",
        "propertyName": "<string>",
        "id": "<string>"
      }
    ],
    "embedVersion": "<string>"
  }
]

Required Scopes

This API requires one of the following scopes:
  • forms

Query Parameters

limit
integer
offset
integer
formTypes
enum<string>
Available options:
ALL

Response

portalId
integer
required
guid
string
required
name
string
required
action
string
method
string
cssClass
string
redirect
string
submitText
string
followUpId
string
notifyRecipients
string
leadNurturingCampaignId
string
formFieldGroups
object[]
createdAt
integer
updatedAt
integer
performableHtml
string
migratedFrom
string
ignoreCurrentValues
boolean
metaData
object[]
deletable
boolean
inlineMessage
string
tmsId
string
captchaEnabled
boolean
campaignGuid
string
cloneable
boolean
editable
boolean
formType
string
deletedAt
integer
themeName
string
parentId
integer
style
string
isPublished
boolean
publishAt
integer
unpublishAt
integer
publishedAt
integer
customUid
string
createMarketableContact
boolean
editVersion
integer
thankYouMessageJson
string
themeColor
string
alwaysCreateNewCompany
boolean
internalUpdatedAt
integer
businessUnitId
integer
portableKey
string
paymentSessionTemplateIds
string[]
selectedExternalOptions
object[]
embedVersion
string