Get all forms from an account | Forms API

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Marketing

Required Scope:

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.

Use case for this endpoint: This might be useful for an integration featuring an external form builder. You might use this endpoint to get a current form to modify in that builder.

Response details

For any form, there may be a set of associated fields, which you'll get as part of the returned data.

Required parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.

Optional parameters	How to use	Description
Limit	limit= Used in the request URL	The number of records to return. Has no default; if ommitted, all forms are returned.
Offset	offset= Used in the request URL	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. For example, if your first request specified limit=10, your next request should include limit=10&offset=10. The request after that should include limit=10&offset=20, and so on and so forth.
FormTypes	formTypes= Used in the request URL	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).

Example URL: https://api.hubapi.com/forms/v2/forms

JSON

Example GET URL: https://api.hubapi.com/forms/v2/forms Example response, JSON output includes 2 forms, one with fields and one without any fields: [ { "portalId": 62515, "guid": "0033cf74de6a48c4ac5d805d72d69822", "name": "Example Form Name", "action": "", "method": "POST", "cssClass": "", "redirect": "", "submitText": "Submit", "followUpId": "", "notifyRecipients": "", "leadNurturingCampaignId": "", "formFieldGroups": [ { "fields": [ { "name": "firstname", "label": "First Name", "type": "string", "fieldType": "text", "description": "", "groupName": "", "displayOrder": 0, "required": false, "selectedOptions": [ ], "options": [ ], "validation": { "name": "", "message": "", "data": "", "useDefaultBlockList": false, "blockedEmailAddresses": [ ] }, "enabled": true, "hidden": false, "defaultValue": "", "isSmartField": false, "unselectedLabel": "", "placeholder": "", "dependentFieldFilters": [ ], "labelHidden": false } ], "default": true, "isSmartGroup": false, "richText": { "content": "" } }, { "fields": [ { "name": "lastname", "label": "Last Name", "type": "string", "fieldType": "text", "description": "", "groupName": "", "displayOrder": 1, "required": false, "selectedOptions": [ ], "options": [ ], "validation": { "name": "", "message": "", "data": "", "useDefaultBlockList": false, "blockedEmailAddresses": [ ] }, "enabled": true, "hidden": false, "defaultValue": "", "isSmartField": false, "unselectedLabel": "", "placeholder": "", "dependentFieldFilters": [ ], "labelHidden": false } ], "default": true, "isSmartGroup": false, "richText": { "content": "" } } ], "createdAt": 1318534279910, "updatedAt": 1463633126831, "performableHtml": "", "migratedFrom": "ld", "ignoreCurrentValues": false, "metaData": [ ], "deletable": true, "inlineMessage": "", "tmsId": "", "captchaEnabled": false, "campaignGuid": "", "cloneable": true, "editable": true, "formType": "HUBSPOT" }, { "portalId": 62515, "guid": "00442a1e-6d99-4abc-aac7-2a7d62a94284", "name": "Example Form 2", "action": "", "method": "", "cssClass": "", "redirect": "", "submitText": "", "followUpId": "", "notifyRecipients": "", "leadNurturingCampaignId": "", "formFieldGroups": [ ], "createdAt": 0, "updatedAt": 1465009327571, "performableHtml": "", "migratedFrom": "", "ignoreCurrentValues": false, "metaData": [ ], "deletable": true, "inlineMessage": "", "tmsId": "", "captchaEnabled": false, "campaignGuid": "", "cloneable": true, "editable": true, "formType": "HUBSPOT" } ]