GET
/
forms
/
v2
/
forms
/
{form_guid}
Get a form by its unique ID
curl --request GET \
  --url https://api.hubapi.com/forms/v2/forms/{form_guid} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

form_guid
string
required

The Form unique ID for the form that you're requesting in your API call.

Response

200
application/json

Form retrieved successfully

The response is of type object.