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:

Account

Field Name  Data Type  Required  Editable  Description 
<id> integer Pardot ID for this account
<level> string The level of product for the account
<website> string Account website
<vanity_domain> string Custom vanity domain name
<plugin_campaign_id> integer Plugin ID for account campaign
<tracking_code_template> string Markup and code for use in tracking templates
<address1> string Account contact address, line 1
<address2> string Account contact address, line 2
<city> string Account contact city
<state> string Account contact state
<territory> string Account contact territory
<zip> integer Account contact zip code
<country> string Account contact country (full string)
<phone> string Account contact phone number
<fax> string Account contact fax number

Campaign

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this campaign
<name> string X Campaign's name
<cost> integer X Cost associated to the campaign

Custom Field

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this custom field
<name> string X Custom field's name
<field_id> string API ID for custom field
<type> string X type of field
<type_id> integer Pardot ID for custom field's type
<created_at> timestamp Time custom field was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time custom field was updated; Time is reported in API user's preferred timezone
<is_record_multiple_responses> boolean X If true, this custom field will record multiple responses
<crm_id> string X The CRM ID of the field you would like to map to this custom field
<is_use_values> boolean X If true, this custom field will use predefined values

Custom Redirect

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this custom redirect
<name> string Custom redirect's name
<Url> string URL for the custom redirect
<destination> string URL the custom redirect leads to
<campaign> string The campaign associated with this custom redirect
<created_at> timestamp Time custom redirect was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time custom redirect was updated; Time is reported in API user's preferred timezone

Dynamic Content

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this dynamic content
<name> string Dynamic content's name
<embedCode> string Code to embed this dynamic content onto your webpage
<embedUrl> string URL to embed this dynamic content
<baseContent> string The default dynamic content
<basedOn> string Field that this dynamic content is based on
<variation> node The 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> timestamp Time dynamic content was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time dynamic content was updated; Time is reported in API user's preferred timezone

Email

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this email
<name> string Name of this email
<subject> string Email Subject
<message> XML Object Contains text and html elements of different formats
<created_at> Timestamp Time the Email Was Created

Email Clicks

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this email click
<prospect_id> integer Pardot ID for the associated prospect
<url> string URL of the email click
<list_email_id> integer Pardot ID for the associated list email. Value not present if null.
<drip_program_action_id> integer Pardot ID for the associated drip program action. Value not present if null.
<email_template_id> integer Pardot ID for the associated email template. Value not present if null.
<tracker_redirect_id> integer Pardot ID for the associated tracker redirect. Value not present if null.
<created_at> timestamp Time that email click occurred; Time is reported in API user's preferred timezone

Form

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this form
<name> string Form's name
<campaign_id> string Pardot ID of the campaign associated with this form
<embed_code> string The code used to embed the form on your webpage
<created_at> timestamp Time form was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time form was updated; Time is reported in API user's preferred timezone

Identified Company

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this identified company
<name> string Identified Company's name
<street_address> string Identified Company's street address
<city> string Identified Company's city
<state> string Identified Company's state
<postal_code> string Identified Company's postal code
<country> string Identified Company's country
<email> string Identified Company's email address

Lifecycle History

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID of this lifecycle history
<prospect_id> integer Pardot's ID for the prospect in this stage
<previous_stage_id> integer Pardot ID of the stage this prospect was previously in
<next_stage_id> integer Pardot ID of the stage this prospect will be in next
<seconds_elapsed> integer Number of seconds for prospect to get to current stage
<created_at> timestamp Time lifecycle history was created in Pardot; Time is reported in API user's preferred timezone

Lifecycle Stage

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID of this lifecycle stage
<name> string Lifecycle stage's name
<position> integer Lifcycle stage's position in lifecycle
<is_locked> boolean If true, lifecycle stage is locked

List

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID of this list
<name> string X List's name (internal to Pardot)
<is_public> boolean X If true, list will show on EPC pages to prospects
<is_dynamic> boolean If true, list has prospects dynamically added to it via a set of chosen rules
<title> string X List's title (visible to subscribers)
<description> string X List's description
<is_crm_visible> boolean X If true, list will be visible in CRM to add or remove from
<created_at> timestamp Time list was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time list was updated; Time is reported in API user's preferred timezone

List Membership

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this list membership
<list_id> integer X Pardot ID of the list for this membership
<prospect_id> integer X Pardot ID of the prospect for this membership
<opted_out> integer X If value is 1, the prospect is unsubscribed from receiving emails from this list
<created_at> timestamp Time that this membership was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time that this membership was updated; Time is reported in API user's preferred timezone

Opportunity

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this opportunity
<campaign_id> integer X X Pardot 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 done by providing campaign_id=<campaign_id> during an UPDATE> request. See XML Response Formats in Using Opportunities for more details.
<name> string X X Opportunity's name
<value> float X X Opportunity's value
Restrictions: value must be a positive numeric value
<probability> integer X X Opportunity's probability
Restrictions: value must be a positive numeric value between 0 and 100 inclusive
<type> string X Opportunity's type
<stage> string X Opportunity's stage
<status> string X Opportunity's status
Restrictions: status must be either won, lost, or open
<closed_at> timestamp X Opportunity's closed date
Note: if this is left blank, the closed_at timestamp (Closed Date within the app) will not be set, even when the Opportunity's stage, status or probability are set to indicate opportunity closure
<created_at> timestamp Time opportunity was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time opportunity was updated in Pardot; Time is reported in API user's preferred timezone

Profile

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this profile
<name> string Profile's name

Profile Criteria

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this profile criteria
<name> string Profile criteria's name
<matches> string X The matching status of this profile criteria with the current prospect
Restrictions: Updates may be performed by using the values match, nomatch, or unknown

Prospect

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this prospect
<campaign_id> integer X Pardot 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 done by providing campaign_id=<campaign_id> during an UPDATE> request. See XML Response Formats in Using Prospects for more details.
<salutation> string X Prospect's formal prefix
<first_name> string X Prospect's first name
<last_name> string X Prospect's last name
<email> string X X Prospect's email address
<password> string X Prospect's password
<company> string X Prospect's company
<prospect_account_id> integer X Prospect's account ID
<website> string X Prospect's website URL
<job_title> string X Prospect's job title
<department> string X Prospect's department
<country> string X Prospect's country
<address_one> string X Prospect's address, line 1
<address_two> string X Prospect's address, line 2
<city> string X Prospect's city
<state> string X Prospect's US state
<territory> string X Prospect's territory
<zip> string X Prospect's postal code
<phone> string X Prospect's phone number
<fax> string X Prospect's fax number
<source> string X Prospect's source
<annual_revenue> string X Prospect's annual revenue
<employees> string X Prospect's number of employees
<industry> string X Prospect's industry
<years_in_business> string X Prospect's number of years in business
<comments> string X Comments about this prospect
<notes> string X Notes about this prospect
<score> integer X Prospect's score
<grade> string Prospect's letter grade
<last_activity_at> timestamp Time stamp of this prospect's latest visitor activity; Time is reported in API user's preferred timezone
<recent_interaction> string Describes the prospect's most recent interaction with Pardot
<crm_lead_fid> string Prospect's lead ID in a supported CRM system
<crm_contact_fid> string Prospect's contact ID in a supported CRM system
<crm_owner_fid> string Prospect's owner ID in a supported CRM system
<crm_account_fid> string Account ID in a supported CRM system
<crm_last_sync> timestamp Last time this prospect was synced with a supported CRM system
<crm_url> string URL to view the prospect within the CRM system
<is_do_not_email> boolean X If value is 1, prospect prefers not to be emailed
<is_do_not_call> boolean X If value is 1, prospect prefers not to be called
<opted_out> boolean If value is 1, prospect has opted out of marketing communications
<is_reviewed> boolean X If value is 1, prospect has been reviewed
<is_starred> boolean X If value is 1, prospect has been starred
<created_at> timestamp Time prospect was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time prospect was updated in Pardot; Time is reported in API user's preferred timezone

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 Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID of the prospect account
<name> string X The name prospect account

Tag

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this tag
<name> string Tag's name
<created_at> timestamp Time tag was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time tag was updated; Time is reported in API user's preferred timezone

Tag Object

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID of the tag object
<tag_id> integer The Pardot ID of the tag
<type> string The type of object associated with the tag
<object_id> integer The Pardot ID of the object
<created_at> timestamp Time tag was associated with the object in Pardot; Time is reported in API user's preferred timezone

User

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID of the user
<email> string User's email address
<first_name> string User's first name
<last_name> string User's last name
<job_title> string User's job title
<role> string User's role
<created_at> timestamp Time user was created in Pardot; Time is reported in the API user's preferred timezone
<updated_at> timestamp Last time user was updated in Pardot; Time is reported in the API user's preferred timezone

Visit

Field Name  Data Type  Required  Editable  Description 
<id> integer Pardot ID for this visit
<visitor_id> integer Pardot ID for the associated visitor
<prospect_id> integer Pardot ID for the associated prospect
<visitor_page_view_count> integer Number of page views for this visit
<first_visitor_page_view_at> timestamp Time of first page view for this visit; Time is reported in API user's preferred timezone
<last_visitor_page_view_at> timestamp Time of last page view for this visit; Time is reported in API user's preferred timezone
<duration_in_seconds> integer Length of this visit
<campaign_parameter> string Visit's campaign parameter utm_campaign from Google Analytics
<medium_parameter> string Visit's medium parameter utm_medium from Google Analytics
<source_parameter> string Visit's source parameter utm_source from Google Analytics
<content_parameter> string Visit's content parameter utm_content from Google Analytics
<term_parameter> string Visit's term parameter utm_term from Google Analytics
<created_at> timestamp Time visit was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time visit was updated in Pardot; Time is reported in API user's preferred timezone

Visitor

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this visitor
<page_view_count> integer Number of page views by this visitor
<ip_address> string Visitor's IP address
<hostname> string Visitor's hostname
<campaign_parameter> string Visitor's campaign parameter utm_campaign from Google Analytics
<medium_parameter> string Visitor's medium parameter utm_medium from Google Analytics
<source_parameter> string Visitor's source parameter utm_source from Google Analytics
<content_parameter> string Visitor's content parameter utm_content from Google Analytics
<term_parameter> string Visitor's term parameter utm_term from Google Analytics
<created_at> timestamp Time visitor was created in Pardot; Time is reported in API user's preferred timezone
<updated_at> timestamp Last time visitor was updated in Pardot; Time is reported in API user's preferred timezone

Visitor Activity

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this visitor activity
<prospect_id> integer Pardot ID for the associated prospect
<visitor_id> integer Pardot ID for the associated visitor
<type> integer Visitor activity's type number; See listing below
<type_name> string Visitor activity's type name; See listing below
<details> string Details 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> integer Pardot ID of the email associated with this visitor activity
Note: This node will only appear if this visitor activity has an email associated with it
<form_id> integer Pardot ID of the form associated with this visitor activity
Note: This node will only appear if this visitor activity has a form associated with it
<form_handler_id> integer Pardot ID of the form handler associated with this visitor activity
Note: This node will only appear if this visitor activity has a form handler associated with it
<site_search_query_id> integer Pardot ID of the site search query associated with this visitor activity
Note: This node will only appear if this visitor activity has a site search query associated with it
<landing_page_id> integer Pardot ID of the landing page associated with this visitor activity
Note: This node will only appear if this visitor activity has a landing page associated with it
<paid_search_id_id> integer Pardot ID of the paid search ad associated with this visitor activity
Note: This node will only appear if this visitor activity has a paid search ad associated with it
<multivariate_test_variation_id> integer Pardot ID of the multivariate test variation associated with this visitor activity
Note: This node will only appear if this visitor activity has a multivariate test variation associated with it
<visitor_page_view_id> integer Pardot ID of the visitor page view associated with this visitor activity
Note: This node will only appear if this visitor activity has a visitor page view associated with it
<file_id> integer Pardot ID of the file associated with this visitor activity
Note: This node will only appear if this visitor activity has a file associated with it
<campaign> object Campaign information including id, name, and cost.
<created_at> timestamp Time that visitor activity occurred; Time is reported in API user's preferred timezone


Visitor Activities may have the following values for <type>:

Visitor Page View

Field Name  Data Type  Required  Editable  Description 
<id> integer Pardot ID for this visitor page view
<url> string Page view URL
<title> string Page title
<created_at> timestamp Time page view occurred; Time is reported in API user's preferred timezone

Visitor Referrer

Field Name  Data Type  Required  Editable  Description 
<id> integer X Pardot ID for this visitor referrer
<referrer> string Referrer's URL
<vendor> string Referrer's vendor (such as 'Google' or 'Yahoo')
<type> string Referrer's type (such as 'Natural Search')
<query> string Referrer's search query