Prospect Account Object

Prospect accounts group prospect accounts that work for the same company under the same umbrella, keeping all the information about the company in one place. Use prospect account resources to request the name and Pardot ID of your prospect accounts. Learn more about prospect accounts in Salesforce Help.

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

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

Prospect Account Resources

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/prospect-accounts/<id>?<params>Prospect > Prospect Accounts > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/prospect-accounts?<params>Prospect > Prospect Accounts > View ability

Fields

Read-Only Fields

FieldTypeDescription
idIntegerID of the object.
nameStringName of the object.
salesforceIdStringID of the Salesforce object representing this object.
isDeletedBooleanTrue if the object is in the recycle bin in Pardot.
annualRevenueStringAnnual Revenue of the object.
billingAddressOneStringBilling Address of the object.
billingAddressTwoStringSecond Billing Address of the object.
billingCityStringCity of the object.
billingCountryStringCounty of the object.
billingStateStringState of the object.
billingZipStringZip of the object.
descriptionStringDescription of the object.
employeesStringEmployees of the object.
faxStringFax of the object.
industryStringIndustry of the object.
numberStringNumber of the object.
ownershipStringOwnership of the object.
phoneStringPhone Number of the object.
ratingStringRating of the object.
shippingAddressOneStringShipping Address of the object.
shippingAddressTwoStringSecond Shipping Address of the object.
shippingCityStringShipping Address city of the object.
shippingCountryStringShipping Address country of the object.
shippingStateStringShipping Address state of the object.
shippingZipStringShipping Address zip of the object.
sicStringSIC of the object.
siteStringSite of the object.
tickerSymbolStringTicker Symbol of the object.
typeStringType of the object.
websiteStringWebsite of the 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.
assignedToIdIntegerID of the user who the object record is assigned to.
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 the object record is assigned to. See documentation for User for fields.

Prospect Account Read

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

Example request:

Example response:

Prospect Account Query

Retrieving a collection of prospect accounts 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
  • salesforceId

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 prospect accounts where ID is equal to the given integer value.
idGreaterThanReturns any prospect accounts where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any prospect accounts where ID is greater than or equal to the specified value.
idLessThanReturns any prospect accounts where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any prospect accounts where ID is less than or equal to the specified value.

Example request:

Example response: