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>" }]This endpoint is used to return all forms that have been created in an account. Forms are standard tools that can be used to generate website leads.
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>" }]formsThe number of records to return. Has no default; if omitted, all forms are returned.
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.
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).
ALLForms retrieved successfully
The portal ID
The unique identifier for the form
The name of the form
The action URL for the form
The HTTP method for the form
The CSS class for the form
The redirect URL after form submission
The text for the submit button
The follow-up ID
The notification recipients
The lead nurturing campaign ID
Show child attributes
The timestamp when the form was created
The timestamp when the form was last updated
The performable HTML
What the form was migrated from
Whether to ignore current values
Whether the form is deletable
The inline message
The TMS ID
Whether CAPTCHA is enabled
The campaign GUID
Whether the form is cloneable
Whether the form is editable
The type of the form
The timestamp when the form was deleted
The theme name
The parent ID
The form style
Whether the form is published
The publish timestamp
The unpublish timestamp
The published timestamp
The custom UID
Whether to create marketable contacts
The edit version
The thank you message JSON
The theme color
Whether to always create new companies
The internal updated timestamp
The business unit ID
The portable key
Show child attributes
The embed version
Was this page helpful?