Form Object

Use forms to collect visitor information and create identified prospects. Learn more about forms in Salesforce Help.

The API to access the Form object collection follows the conventions described in Version 5 Overview.

Include the authentication header with every request. For information on how to authenticate, see Authentication.

Form Resources

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/forms/<id>?<params>Marketing > Forms > Forms > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/forms?<params>Marketing > Forms > Forms > View ability

Fields

Read-Only Fields

FieldTypeDescription
idIntegerID of the object.
nameStringName of the object for identification in Pardot.
campaignIdIntegerThe ID of the campaign associated with this object.
embedCodeStringHTML code to embed this form in an iframe
salesforceIdStringID of the Salesforce object representing this object.
layoutTemplateIdIntegerThe ID of the layout template associated with this object
submitButtonTextStringThe label used for the submit button
beforeFormContentStringThe HTML text displayed above the form
afterFormContentStringThe HTML text displayed below the form
thankYouContentStringThe HTML text displayed after the form is submitted
thankYouCodeStringThank you code is typically Javascript used to call other systems like Google Conversion Tracking
isAlwaysDisplayBooleanAlways display form after submission. Disable the 10 minute waiting period after submitting a form
redirectLocationStringRedirect to this URL instead of showing the "thank you" content
isUseRedirectLocationBooleanWhen redirect location is valid and enabled
fontSizeStringPossible values: default, 8pt, 10pt, 12pt, 14pt , 18pt, 24pt, 36pt
fontFamilyStringPossible values: default, "Helvetica, Arial, Sans-serif", "Georgia, Times, Times New Roman, Serif", "Tahoma, Trebuchet MS, Verdana, Helvetica, Arial, Sans-serif", "Courier New, Courier, Monospace"
fontColorString6 digit number in hexadecimal format such as #123456
labelAlignmentStringPossible values: default, above, left
radioAlignmentStringPossible values: default, horizontal, stacked
checkboxAlignmentStringPossible values: default, horizontal, stacked
requiredCharacterStringPossible values: default , *
isCookielessBooleanKiosk/Data Entry Mode: Do not cookie browser as submitted prospect
showNotProspectBooleanInclude "Not you?" link to allow visitors to reset the form. Valid when isCookieless isn’t set.
isCaptchaEnabledBooleanEnable explicit bot protecting using reCAPTCHA
isDeletedBooleanTrue if the object is in the recycle bin in Pardot.
trackerDomainIdIntegerThe ID of the tracker domain associated with this object.
createdAtDateTimeCreation time of the object.
updatedAtDateTimeLast update time of the object.
createdByIdIntegerID of the User who created this object.
updatedByIdIntegerID of the User who last updated this object.
folderIdIntegerID of the folder containing this object.
createdByUserUser object representing the user who created this object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated this object. See documentation for User for fields.
layoutTemplateLayoutTemplateLayout Template object representing the layout template associated with this object. See documentation for Layout Template for fields.
trackerDomainTrackerDomainTracker Domain object representing the tracker domain associated with this object. See documentation for Tracker Domain for fields. A null value indicates that the object uses the default tracker domain for the account.
campaignCampaignCampaign object representing the campaign associated with this object. See documentation for Campaign for fields.
folderFolderFolder object representing the folder containing this object. See documentation for Folder for fields.

Form Read

Retrieve a single form object following the conventions described in the Version 5 Overview.

Example request:

Example response:

Form Query

Retrieving a collection of forms follows the conventions described in Version 5 Overview.

Sortable Fields

When executing a query, the following fields can be specified. See the conventions for query described in the Version 5 Overview.

  • id

Example request:

Example response:

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

ParameterDescription
idReturns any forms where ID is equal to the given integer value.
idGreaterThanReturns any forms where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any forms where ID is greater than or equal to the specified value.
idLessThanReturns any forms where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any forms where ID is less than or equal to the specified value.

Example request:

Example response: