There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get all fields from a form

Last updated May 15, 2023

GET /forms/v2/fields/:form_guid

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

forms

For a given portal, return all form fields that have been created on a particular form in a portal. Forms are standard website forms that can be used to generate website leads.

For any form, there may be a set of fields associated with that form in question. You will get all of the fields that are a part of any form as a part of the returned data from this API call.

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.
Form GUID Used in the request URL (see URL example below) The Form unique ID for the form that you're requesting the fields from in your API call.
Optional Parameters How to use Description
None None No optional parameters for this method.

Example URL:  https://api.hubapi.com/forms/v2/fields/561d9ce9-bb4c-45b4-8e32-21cdeaa3a7f0

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example JSON output that includes 3 fields from a form in a HubSpot portal: [ { 'description': '', 'defaultValue': '', 'required': true, 'enabled': true, 'isSmartField': false, 'label': 'LastName', 'groupName': 'contactinformation', 'selectedOptions': [ ], 'fieldType': 'text', 'hidden': false, 'validation': { 'message': '', 'name': '' }, 'type': 'string', 'options': [ ], 'displayOrder': 0, 'name': 'lastname' }, { 'description': '', 'defaultValue': '', 'required': true, 'enabled': true, 'isSmartField': false, 'label': 'FirstName', 'groupName': 'contactinformation', 'selectedOptions': [ ], 'fieldType': 'text', 'hidden': false, 'validation': { 'message': '', 'name': '' }, 'type': 'string', 'options': [ ], 'displayOrder': 1, 'name': 'firstname' }, { 'description': '', 'defaultValue': '', 'required': false, 'enabled': true, 'isSmartField': false, 'label': 'Email', 'groupName': 'contactinformation', 'selectedOptions': [ ], 'fieldType': 'text', 'hidden': false, 'validation': { 'message': 'Pleaseenteravalidemailaddress', 'name': 'email' }, 'type': 'string', 'options': [ ], 'displayOrder': 2, 'name': 'email' } ]