Custom Fields

Use custom fields to capture and track more data about your prospects. You can use custom fields in forms and sync the Pardot fields with Salesforce fields. Learn more about Pardot fields in Salesforce Help.

The API to access the Custom Field object follows the conventions described in Version 5 Overview.

Supported Operations

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/custom-fields/<id>?<params>Prospect > Prospects > Configure Fields ability
CreatePOSThttps://pi.pardot.com/api/v5/objects/custom-fields?<params>Prospect > Prospects > Configure Fields ability
UpdatePATCHhttps://pi.pardot.com/api/v5/objects/custom-fields/<id>?<params>Prospect > Prospects > Configure Fields ability
DeleteDELETEhttps://pi.pardot.com/api/v5/objects/custom-fields/<id>Prospect > Prospects > Configure Fields ability
QueryGEThttps://pi.pardot.com/api/v5/objects/custom-fields?<params>Prospect > Prospects > Configure Fields ability

Fields

Required Editable Fields

FieldTypeDescription
nameStringName of the object for identification in Pardot.
fieldIdStringUser-defined ID of the object.
typeStringPossible values: Text, "Radio Button", Checkbox, Dropdown, Textarea, Multi-Select, Hidden, Number, Date, "CRM User"

Optional Editable Fields

FieldTypeDescription
isRecordMultipleResponsesBooleanTrue if it records multiple responses, false otherwise.
salesforceIdStringSalesforce Id of the object.
isUseValuesBooleanTrue if values are used false otherwise.
valuesPrefillStringWrite-Only field on create operation. Possible values: Countries, "Country Codes", "US States", "US State Codes", "Canadian Provinces", "Canadian Province Codes", "US States and Canadian Provinces", "US State and Canadian Province Codes", "Japanese Prefectures", "Japanese Prefecture Codes"
isRequiredBooleanTrue if the custom field is required.

Read-Only Fields

FieldTypeDescription
idIntegerID of this object.
isAnalyticsSyncedBooleanTrue if the object is synced to Analytics.
createdAtDateTimeCreation time of this object.
updatedAtDateTimeLast updated time for the object.
createdByIdIntegerID of the user who created the object.
updatedByIdIntegerID of the user who last updated the object.
createdByUserUser object representing the user who created the object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated the object. See documentation for User for fields.

Custom Field Read

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

Example request:

Example response:

Custom Field Query

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

Sortable Fields

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

  • id
  • createdAt
  • updatedAt

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 custom fields where ID is equal to the given integer value.
idGreaterThanReturns any custom fields where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any custom fields where ID is greater than or equal to the specified value.
idLessThanReturns any custom fields where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any custom fields where ID is less than or equal to the specified value.
createdAtReturns any custom fields where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any custom fields where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any custom fields where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any custom fields where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any custom fields where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any custom fields where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any custom fields where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any custom fields where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any custom fields where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any custom fields where UpdatedAt is before or equal to the given datetime value.

Example request:

Example response: