You're among the first to explore our new HubSpot developer docs. Dive in and share your feedback here.
curl --request GET \
--url https://api.hubapi.com/forms/v2/forms \
--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>"
}
]
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 \
--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>"
}
]
The access token received from the authorization server in the OAuth 2.0 flow.
The 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).
ALL
Forms retrieved successfully
The response is of type object[]
.