Prospects

Use the prospect resources to create and delete prospects, and to query and modify their information. Learn more about prospects in Salesforce Help.

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

Supported Operations

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/prospects/<id>?<params>Prospect > Prospects > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/prospects?<params>Prospect > Prospects > View ability

Fields

Read-Only Fields

FieldTypeDescription
idIntegerID of the object.
addressOneStringProspect's address, line 1.
addressTwoStringProspect's address, line 2.
annualRevenueStringProspect's annual revenue.
campaignIdIntegerPardot campaign related to this object.
campaignParameterStringProspect's campaign parameter utm_campaign from Google Analytics.
salesforceCampaignIdStringThe alpha-numeric Id of the associated campaign in the Salesforce Org.
cityStringProspect's city.
commentsStringComments about this prospect.
companyStringProspect's company.
contentParameterStringProspect's content parameter utm_content from Google Analytics.
convertedAtDateTimeTime when prospect was converted from visitor.
convertedFromObjectNameStringName of object associated with visitor activity that resulted in prospect being converted from visitor.
convertedFromObjectTypeStringType of object associated with visitor activity that resulted in prospect being converted from visitor. Supported values include 'Form', 'FormHandler', 'LandingPage', 'MultivariateTestVariation', and 'Video'.
countryStringProspect's country.
salesforceAccountIdStringAccount ID in a supported Salesforce system.
salesforceContactIdStringProspect's contact ID in a supported Salesforce system.
salesforceLastSyncDateTimeLast time this prospect was synced with a supported Salesforce system.
salesforceLeadIdStringProspect's lead ID in a supported Salesforce system.
salesforceOwnerIdStringProspect's owner ID in a supported Salesforce system.
departmentStringProspect's department.
emailStringProspect's email address.
emailBouncedAtDateTimeTime when prospect email address hard bounced.
emailBouncedReasonStringReason why prospect email address hard bounced.
employeesStringProspect's number of employees.
faxStringProspect's fax number.
firstActivityAtDateTimeTime when first visitor activity occurred for this prospect.
firstAssignedAtDateTimeTime prospect was first assigned to a user.
firstNameStringProspect's first name.
firstReferrerQueryStringFirst referrer's search query.
firstReferrerTypeStringFirst referrer's vendor and type (such as 'Google Natural Search').
firstReferrerUrlStringFirst referrer's URL.
gradeStringProspect's letter grade.
industryStringProspect's industry.
isDeletedBooleanTrue if the object is in the recycle bin in Pardot.
isDoNotCallBooleanIf true, prospect prefers not to be called.
isDoNotEmailBooleanIf true, prospect prefers not to be emailed.
isEmailHardBouncedBooleanIf true, prospect email address has hard bounced.
isReviewedBooleanIf true, prospect has been reviewed.
isStarredBooleanIf true, prospect has been starred.
jobTitleStringProspect's job title.
lastActivityAtDateTimeTime stamp of this prospect's latest visitor activity.
lastNameStringProspect's last name.
mediumParameterStringProspect's medium parameter utm_medium from Google Analytics.
notesStringNotes about this prospect.
optedOutBooleanIf true, prospect has opted out of marketing communications.
passwordStringProspect's password.
phoneStringProspect's phone number.
prospectAccountIdIntegerProspect's account ID.
salesforceIdStringSalesforce Id of the object.
salutationStringProspect's formal prefix.
scoreIntegerProspect's score.
sourceStringProspect's source.
sourceParameterStringProspect's source parameter utm_source from Google Analytics.
stateStringProspect's US state.
termParameterStringProspect's term parameter utm_term from Google Analytics.
territoryStringProspect's territory.
userIdIntegerUser the prospect is assigned to.
websiteStringProspect's website URL.
yearsInBusinessStringProspect's number of years in business.
zipStringProspect's postal code.
assignedToIdIntegerUser the prospect is assigned to.
profileIdIntegerPardot profile related to this object.
salesforceUrlStringURL to view the prospect within the Salesforce system.
lifecycleStageIdIntegerPardot lifecycle stage related to this object.
recentInteractionStringDescribes the prospect's most recent interaction with Pardot.
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.
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.
assignedToUserUser object representing the user who this object is assigned to. See documentation for User for fields.
campaignCampaignCampaign object representing the campaign related to this object. See documentation for Campaign for fields.
prospectAccountProspect AccountProspect Account object representing the prospect account related to this object. See documentation for Prospect Account for fields.

Prospect Read

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

Example request:

Example response:

Prospect Query

Retrieving a collection of prospect 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
  • lastActivityAt
  • 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 folders where ID is equal to the given integer value.
idGreaterThanReturns any folders where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any folders where ID is greater than or equal to the specified value.
idLessThanReturns any folders where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any folders 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.
lastActivityAtReturns any custom fields where LastActivityAt is equal to the given datetime value.
lastActivityAtAfterReturns any custom fields where LastActivityAt is after the given datetime value, non-inclusive.
lastActivityAtAfterOrEqualToReturns any custom fields where LastActivityAt is after or equal to the given datetime value.
lastActivityAtBeforeReturns any custom fields where LastActivityAt is before the given datetime value, non-inclusive.
lastActivityAtBeforeOrEqualToReturns any custom fields where LastActivityAt is before or equal to the given datetime value.
userIdReturns any folders where UserId is equal to the given integer value.
userIdGreaterThanReturns any folders where UserId is greater than the specified value, non-inclusive.
userIdGreaterThanOrEqualToReturns any folders where UserId is greater than or equal to the specified value.
userIdLessThanReturns any folders where UserId is less than the specified value, non-inclusive.
userIdLessThanOrEqualToReturns any folders where UserId is less than or equal to the specified value.
assignedToIdReturns any folders where AssignedToId is equal to the given integer value.
assignedToIdGreaterThanReturns any folders where AssignedToId is greater than the specified value, non-inclusive.
assignedToIdGreaterThanOrEqualToReturns any folders where AssignedToId is greater than or equal to the specified value.
assignedToIdLessThanReturns any folders where AssignedToId is less than the specified value, non-inclusive.
assignedToIdLessThanOrEqualToReturns any folders where AssignedToId is less than or equal to the specified value.

Example request:

Example response: