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

The number of records to return. Has no default; if omitted, all forms are returned.

offset
integer

Used to page through the results. If there are more records in your account than the limit parameter, you will need to include an offset equal to the number of forms you've already requested.

formTypes
enum<string>

By default non-marketing forms are filtered out of this endpoint. To request all forms, use this parameter with the value of ALL (case sensitive).

Available options:
ALL

Response

Forms retrieved successfully

portalId
integer
required

The portal ID

guid
string
required

The unique identifier for the form

name
string
required

The name of the form

action
string

The action URL for the form

method
string

The HTTP method for the form

cssClass
string

The CSS class for the form

redirect
string

The redirect URL after form submission

submitText
string

The text for the submit button

followUpId
string

The follow-up ID

notifyRecipients
string

The notification recipients

leadNurturingCampaignId
string

The lead nurturing campaign ID

formFieldGroups
object[]
createdAt
integer

The timestamp when the form was created

updatedAt
integer

The timestamp when the form was last updated

performableHtml
string

The performable HTML

migratedFrom
string

What the form was migrated from

ignoreCurrentValues
boolean

Whether to ignore current values

metaData
object[]
deletable
boolean

Whether the form is deletable

inlineMessage
string

The inline message

tmsId
string

The TMS ID

captchaEnabled
boolean

Whether CAPTCHA is enabled

campaignGuid
string

The campaign GUID

cloneable
boolean

Whether the form is cloneable

editable
boolean

Whether the form is editable

formType
string

The type of the form

deletedAt
integer

The timestamp when the form was deleted

themeName
string

The theme name

parentId
integer

The parent ID

style
string

The form style

isPublished
boolean

Whether the form is published

publishAt
integer

The publish timestamp

unpublishAt
integer

The unpublish timestamp

publishedAt
integer

The published timestamp

customUid
string

The custom UID

createMarketableContact
boolean

Whether to create marketable contacts

editVersion
integer

The edit version

thankYouMessageJson
string

The thank you message JSON

themeColor
string

The theme color

alwaysCreateNewCompany
boolean

Whether to always create new companies

internalUpdatedAt
integer

The internal updated timestamp

businessUnitId
integer

The business unit ID

portableKey
string

The portable key

paymentSessionTemplateIds
string[]
selectedExternalOptions
object[]
embedVersion
string

The embed version