Object Field References

Each field returned by the API maps to a field within the Pardot user interface. The tables in this section list all fields that can be returned and/or updated via the API. Consider the following limitations:

  • Fields marked as 'Editable' can be manipulated through create, update, and upsert requests.
  • 'Required' denotes that the specified field can't be left without a value during insert and some upsert requests. update requests that clear a required field are declined.
  • During update requests, the parameter names submitted to the API and tag names in the API's response match field names within the Pardot user interface unless otherwise specified.

Account

Field NameData TypeRequiredEditableDescription
<id>integerPardot ID for this account
<level>stringThe level of product for the account
<website>stringAccount website
<vanity_domain>stringCustom vanity domain name
<plugin_campaign_id>integerPlugin ID for account campaign
<tracking_code_template>stringMarkup and code for use in tracking templates
<address1>stringAccount contact address, line 1
<address2>stringAccount contact address, line 2
<city>stringAccount contact city
<state>stringAccount contact state
<territory>stringAccount contact territory
<zip>integerAccount contact zip code
<country>stringAccount contact country (full string)
<phone>stringAccount contact phone number
<fax>stringAccount contact fax number

Campaign

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this campaign
<name>stringXCampaign's name
<cost>integerXCost associated to the campaign

Custom Field

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this custom field
<name>stringXCustom field's name
<field_id>stringAPI ID for custom field
<type>stringXType of field
<type_id>integerPardot ID for custom field's type
<created_at>timestampTime custom field is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time custom field was updated; Time is reported in API user's preferred timezone
<is_record_multiple_responses>booleanXIf true, this custom field will record multiple responses
<crm_id>stringXThe CRM ID of the field you want to map to this custom field
<is_use_values>booleanXIf true, this custom field uses predefined values
<is_analytics_synced>booleanXIf true, this custom field is marked to sync with Tableau CRM

Custom Redirect

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this custom redirect
<name>stringCustom redirect's name
<Url>stringURL for the custom redirect
<destination>stringURL the custom redirect leads to
<campaign>stringThe campaign associated with this custom redirect
<created_at>timestampTime custom redirect is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time custom redirect was updated; Time is reported in API user's preferred timezone

Dynamic Content

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this dynamic content
<name>stringDynamic content's name
<embedCode>stringCode to embed this dynamic content onto your webpage
<embedUrl>stringURL to embed this dynamic content
<baseContent>stringThe default dynamic content
<basedOn>stringField that this dynamic content is based on
<variation>nodeThe variation of content prospect will see based on the field's value. Note: Information about a variation is returned in a <variation> node in the XML response. It contains the value of the field in the <comparison> tag and the content of the variation in the <content> tag
<created_at>timestampTime dynamic content is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time dynamic content was updated; Time is reported in API user's preferred timezone

Email

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this email
<name>stringName of this email
<subject>stringEmail Subject
<message>XML ObjectContains text and html elements of different formats
<created_at>TimestampTime the Email is created

Email Clicks

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this email click
<prospect_id>integerPardot ID for the associated prospect
<url>stringURL of the email click
<list_email_id>integerPardot ID for the associated list email. Value not present if null.
<drip_program_action_id>integerPardot ID for the associated drip program action. Value not present if null.
<email_template_id>integerPardot ID for the associated email template. Value not present if null.
<tracker_redirect_id>integerPardot ID for the associated tracker redirect. Value not present if null.
<created_at>timestampTime that email click occurs; Time is reported in API user's preferred timezone

Form

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this form
<name>stringForm's name
<campaign_id>stringPardot ID of the campaign associated with this form
<embed_code>stringThe code used to embed the form on your webpage
<created_at>timestampTime form is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time form was updated; Time is reported in API user's preferred timezone

Identified Company

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this identified company
<name>stringIdentified Company's name
<street_address>stringIdentified Company's street address
<city>stringIdentified Company's city
<state>stringIdentified Company's state
<postal_code>stringIdentified Company's postal code
<country>stringIdentified Company's country
<email>stringIdentified Company's email address

Lifecycle History

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID of this lifecycle history
<prospect_id>integerPardot's ID for the prospect in this stage
<previous_stage_id>integerPardot ID of the stage this prospect previously was in
<next_stage_id>integerPardot ID of the stage this prospect is in next
<seconds_elapsed>integerNumber of seconds for prospect to get to current stage
<created_at>timestampTime lifecycle history is created in Pardot; Time is reported in API user's preferred timezone

Lifecycle Stage

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID of this lifecycle stage
<name>stringLifecycle stage's name
<position>integerLifcycle stage's position in lifecycle
<is_locked>booleanIf true, lifecycle stage is locked

List

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID of this list
<name>stringXList's name (internal to Pardot)
<is_public>booleanXIf true, list will show on EPC pages to prospects
<is_dynamic>booleanIf true, list has prospects dynamically added to it via a set of chosen rules
<title>stringXList's title (visible to subscribers)
<description>stringXList's description
<is_crm_visible>booleanXIf true, list is visible in CRM to add or remove from
<created_at>timestampTime list is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time list was updated; Time is reported in API user's preferred timezone

List Membership

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this list membership
<list_id>integerXPardot ID of the list for this membership
<prospect_id>integerXPardot ID of the prospect for this membership
<opted_out>integerXIf value is 1, the prospect is unsubscribed from receiving emails from this list
<created_at>timestampTime that this membership is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time that this membership was updated; Time is reported in API user's preferred timezone

Opportunity

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this opportunity
<campaign_id>integerXXPardot ID of the campaign associated with this opportunity
Note: Information about an opportunity's campaign association is returned in a <campaign> node in the XML response. However, updates to campaign associations are made by providing campaign_id=<campaign_id> during an <UPDATE> request. See XML Response in the Campaign documentation for more details.
<name>stringXXOpportunity's name
<value>floatXXOpportunity's value
Restrictions: value must be a positive numeric value
<probability>integerXXOpportunity's probability
Restrictions: value must be a positive numeric value between 0 and 100 inclusive
<type>stringXOpportunity's type
<stage>stringXOpportunity's stage
<status>stringXOpportunity's status
Restrictions: status must be either won, lost, or open
<closed_at>timestampXOpportunity's closed date
Note: if this is left blank, the closed_at timestamp (Closed Date within the app) is not set, even when the Opportunity's stage, status or probability are set to indicate opportunity closure
<created_at>timestampTime opportunity is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time opportunity was updated in Pardot; Time is reported in API user's preferred timezone

Profile

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this profile
<name>stringProfile's name

Profile Criteria

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this profile criteria
<name>stringProfile criteria's name
<matches>stringXThe matching status of this profile criteria with the current prospect
Restrictions: Updates can be performed by using the values match, nomatch, or unknown

Prospect

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this prospect
<campaign_id>integerXPardot ID of the campaign associated with this prospect
Note: Information about a prospect's campaign association is returned in a <campaign> node in the XML response. However, updates to campaign associations are made by providing campaign_id=<campaign_id> during an <UPDATE> request. See XML Response Formats in Prospects for more details.
<salutation>stringXProspect's formal prefix
<first_name>stringXProspect's first name
<last_name>stringXProspect's last name
<email>stringXXProspect's email address
<password>stringXProspect's password
<company>stringXProspect's company
<prospect_account_id>integerXProspect's account ID
<website>stringXProspect's website URL
<job_title>stringXProspect's job title
<department>stringXProspect's department
<country>stringXProspect's country
<address_one>stringXProspect's address, line 1
<address_two>stringXProspect's address, line 2
<city>stringXProspect's city
<state>stringXProspect's US state
<territory>stringXProspect's territory
<zip>stringXProspect's postal code
<phone>stringXProspect's phone number
<fax>stringXProspect's fax number
<source>stringXProspect's source
<annual_revenue>stringXProspect's annual revenue
<employees>stringXProspect's number of employees
<industry>stringXProspect's industry
<years_in_business>stringXProspect's number of years in business
<comments>stringXComments about this prospect
<notes>stringXNotes about this prospect
Note: Available for export, but only exported if selected via fields parameter specified in export create request
<score>integerXProspect's score
<grade>stringProspect's letter grade
Note: Available for export, but only exported if selected via fields parameter specified in export create request
<last_activity_at>timestampTime stamp of this prospect's latest visitor activity; Time is reported in API user's preferred timezone
<recent_interaction>stringDescribes the prospect's most recent interaction with Pardot (Not available for V3/V4 export)
<crm_lead_fid>stringProspect's lead ID in a supported CRM system
<crm_contact_fid>stringProspect's contact ID in a supported CRM system
<crm_owner_fid>stringProspect's owner ID in a supported CRM system
<crm_account_fid>stringAccount ID in a supported CRM system
<crm_last_sync>timestampLast time this prospect was synced with a supported CRM system
<crm_url>stringURL to view the prospect within the CRM system (Not available for V3/V4 export)
<is_do_not_email>booleanXIf value is 1, prospect prefers not to be emailed
<is_do_not_call>booleanXIf value is 1, prospect prefers not to be called
<opted_out>booleanIf value is 1, prospect has opted out of marketing communications
<is_reviewed>booleanXIf value is 1, prospect has been reviewed
<is_starred>booleanXIf value is 1, prospect has been starred
<is_archived>booleanXIf value is 1, prospect has been archived
<created_at>timestampTime prospect is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time prospect was updated in Pardot; Time is reported in API user's preferred timezone

Additional prospect fields available for Export

When using the v3 Export API or v4 Export API to export prospects, the following prospect fields are selectable for export in addition to the prospect fields listed above.
Note: The following fields are only available via the Export API and are only exported if selected via fields parameter specified in export create request.

Field NameData TypeDescription
<converted_at>timestampTime when prospect was converted from visitor; Time is reported in API user's preferred timezone
<converted_from_object_type>stringType of object associated with visitor activity that resulted in prospect being converted from visitor. Supported values include 'Form', 'FormHandler', 'LandingPage', 'MultivariateTestVariation', and 'Video'
<converted_from_object_name>stringName of object associated with visitor activity that resulted in prospect being converted from visitor
<is_email_hard_bounced>booleanif value is 1, prospect email address has hard bounced
<email_bounced_at>timestampTime when prospect email address hard bounced; Time is reported in API user's preferred timezone
<email_bounced_reason>stringReason why prospect email address hard bounced
<first_assigned_at>timestampTime prospect was first assigned to a user; Time is reported in API user's preferred timezone
<first_activity_at>timestampTime when first visitor activity occurred for this prospect; Time is reported in API user's preferred timezone
<first_referrer_url>stringFirst referrer's URL
<first_referrer_type>stringFirst referrer's vendor and type (such as 'Google Natural Search')
<first_referrer_query>stringFirst referrer's search query
<campaign_parameter>stringProspect's campaign parameter utm_campaign from Google Analytics
<medium_parameter>stringProspect's medium parameter utm_medium from Google Analytics
<source_parameter>stringProspect's source parameter utm_source from Google Analytics
<content_parameter>stringProspect's content parameter utm_content from Google Analytics
<term_parameter>stringProspect's term parameter utm_term from Google Analytics

Prospect Account

Note: Prospect account fields are fully customizable. To get the most accurate field metadata for your Pardot account, use the describe operation on the prospectAccount API endpoint.

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID of the prospect account
<name>stringXThe name of the prospect account

Tag

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this tag
<name>stringTag's name
<created_at>timestampTime tag is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time tag was updated; Time is reported in API user's preferred timezone

Tag Object

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID of the tag object
<tag_id>integerThe Pardot ID of the tag
<type>stringThe type of object associated with the tag
<object_id>integerThe Pardot ID of the object
<created_at>timestampTime tag is associated with the object in Pardot; Time is reported in API user's preferred timezone

User

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID of the user
<email>stringUser's email address
<first_name>stringUser's first name
<last_name>stringUser's last name
<job_title>stringUser's job title
<role>stringUser's role
<created_at>timestampTime user is created in Pardot; Time is reported in the API user's preferred timezone
<updated_at>timestampLast time user was updated in Pardot; Time is reported in the API user's preferred timezone

Visit

Field NameData TypeRequiredEditableDescription
<id>integerPardot ID for this visit
<visitor_id>integerPardot ID for the associated visitor
<prospect_id>integerPardot ID for the associated prospect
<visitor_page_view_count>integerNumber of page views for this visit
<first_visitor_page_view_at>timestampTime of first page view for this visit; Time is reported in API user's preferred timezone
<last_visitor_page_view_at>timestampTime of last page view for this visit; Time is reported in API user's preferred timezone
<duration_in_seconds>integerLength of this visit
<campaign_parameter>stringVisit's campaign parameter utm_campaign from Google Analytics
<medium_parameter>stringVisit's medium parameter utm_medium from Google Analytics
<source_parameter>stringVisit's source parameter utm_source from Google Analytics
<content_parameter>stringVisit's content parameter utm_content from Google Analytics
<term_parameter>stringVisit's term parameter utm_term from Google Analytics
<created_at>timestampTime visit is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time visit was updated in Pardot; Time is reported in API user's preferred timezone

Visitor

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this visitor
<page_view_count>integerNumber of page views by this visitor
<ip_address>stringVisitor's IP address
<hostname>stringVisitor's hostname
<campaign_parameter>stringVisitor's campaign parameter utm_campaign from Google Analytics
<medium_parameter>stringVisitor's medium parameter utm_medium from Google Analytics
<source_parameter>stringVisitor's source parameter utm_source from Google Analytics
<content_parameter>stringVisitor's content parameter utm_content from Google Analytics
<term_parameter>stringVisitor's term parameter utm_term from Google Analytics
<created_at>timestampTime visitor is created in Pardot; Time is reported in API user's preferred timezone
<updated_at>timestampLast time visitor was updated in Pardot; Time is reported in API user's preferred timezone

Visitor Activity

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this visitor activity
<prospect_id>integerPardot ID for the associated prospect
<visitor_id>integerPardot ID for the associated visitor
<type>integerVisitor activity's type number; See listing below
<type_name>stringVisitor activity's type name; See listing below
<details>stringDetails about this visitor activity such as the name of the object associated with this activity, the search phrase used in a site search query, etc.
<email_id>integerPardot ID of the email associated with this visitor activity
Note: This node appears only if this visitor activity has an email associated with it
<email_template_id>integerPardot ID of the email template associated with this visitor activity
Note: This node appears only if this visitor activity has an email associated with it
<list_email_id>integerPardot ID of the list email associated with this visitor activity
Note: This node appears only if this visitor activity has an email associated with it
<form_id>integerPardot ID of the form associated with this visitor activity
Note: This node appears only if this visitor activity has a form associated with it
<form_handler_id>integerPardot ID of the form handler associated with this visitor activity
Note: This node appears only if this visitor activity has a form handler associated with it
<site_search_query_id>integerPardot ID of the site search query associated with this visitor activity
Note: This node appears only if this visitor activity has a site search query associated with it
<landing_page_id>integerPardot ID of the landing page associated with this visitor activity
Note: This node appears only if this visitor activity has a landing page associated with it
<paid_search_ad_id>integerPardot ID of the paid search ad associated with this visitor activity
Note: This node appears only if this visitor activity has a paid search ad associated with it
<multivariate_test_variation_id>integerPardot ID of the multivariate test variation associated with this visitor activity
Note: This node appears only if this visitor activity has a multivariate test variation associated with it
<file_id>integerPardot ID of the file associated with this visitor activity
Note: This node appears only if this visitor activity has a file associated with it
<custom_redirect_id>integerPardot ID of the custom redirect associated with this visitor activity Note: This node appears only if this visitor activity has a custom redirect associated with it
<campaign>objectCampaign information including id, name, and cost. (Not available for V3/V4 export)
<created_at>timestampTime that visitor activity occurred; Time is reported in API user's preferred timezone
<updated_at>timestampTime that visitor activity update occurred; Time is reported in API user's preferred timezone

Visitor Activity Types

Visitor Activities may have the following values for <type>

  • 1 - Click
  • 2 - View
  • 3 - Error
  • 4 - Success
  • 5 - Session (Omitted from Syncronous and Export endpoints)
  • 6 - Sent
  • 7 - Search
  • 8 - New Opportunity
  • 9 - Opportunity Won
  • 10 - Opportunity Lost
  • 11 - Open
  • 12 - Unsubscribe Page
  • 13 - Bounced
  • 14 - Spam Complaint
  • 15 - Email Preference Page
  • 16 - Resubscribed
  • 17 - Click (Third Party)
  • 18 - Opportunity Reopened
  • 19 - Opportunity Linked
  • 20 - Visit
  • 21 - Custom URL click
  • 22 - Olark Chat
  • 23 - Invited to Webinar
  • 24 - Attended Webinar
  • 25 - Registered for Webinar
  • 26 - Social Post Click
  • 27 - Video View
  • 28 - Event Registered
  • 29 - Event Checked In
  • 30 - Video Conversion
  • 31 - UserVoice Suggestion
  • 32 - UserVoice Comment
  • 33 - UserVoice Ticket
  • 34 - Video Watched (≥ 75% watched)
  • 35 - Indirect Unsubscribe Open
  • 36 - Indirect Bounce
  • 37 - Indirect Resubscribed
  • 38 - Opportunity Unlinked
  • Other - Unknown

Visitor Page View

Field NameData TypeRequiredEditableDescription
<id>integerPardot ID for this visitor page view
<url>stringPage view URL
<title>stringPage title
<created_at>timestampTime page view occurred; Time is reported in API user's preferred timezone

Visitor Referrer

Field NameData TypeRequiredEditableDescription
<id>integerXPardot ID for this visitor referrer
<referrer>stringReferrer's URL
<vendor>stringReferrer's vendor (such as 'Google' or 'Yahoo')
<type>stringReferrer's type (such as 'Natural Search')
<query>stringReferrer's search query