Prospect Accounts
The API to access the Prospect Account object collection follows the conventions described in Version 5 Overview.
Supported Operations
Operation | HTTP Verb | URL Format | Ability Requirements |
---|---|---|---|
Read | GET |
https://pi.pardot.com/api/v5/objects/prospect-accounts/<id>?<params> |
Prospect > Prospect Accounts > View ability |
Query | GET |
https://pi.pardot.com/api/v5/objects/prospect-accounts?<params> |
Prospect > Prospect Accounts > View ability |
Fields
Required Editable Fields
None.
Optional Editable Fields
None.
Read-Only Fields
Field | Type | Description |
---|---|---|
id |
Integer | ID of the object. |
name |
String | Name of the object. |
salesforceId |
String | ID of the Salesforce object representing this object. |
isDeleted |
Boolean | True if the object is in the recycle bin in Pardot. |
annualRevenue |
String | Annual Revenue of the object. |
billingAddressOne |
String | Billing Address of the object. |
billingAddressTwo |
String | Second Billing Address of the object. |
billingCity |
String | City of the object. |
billingCountry |
String | County of the object. |
billingState |
String | State of the object. |
billingZip |
String | Zip of the object. |
description |
String | Description of the object. |
employees |
String | Employees of the object. |
fax |
String | Fax of the object. |
industry |
String | Industry of the object. |
number |
String | Number of the object. |
ownership |
String | Ownership of the object. |
phone |
String | Phone Number of the object. |
rating |
String | Rating of the object. |
shippingAddressOne |
String | Shipping Address of the object. |
shippingAddressTwo |
String | Second Shipping Address of the object. |
shippingCity |
String | Shipping Address city of the object. |
shippingCountry |
String | Shipping Address country of the object. |
shippingState |
String | Shipping Address state of the object. |
shippingZip |
String | Shipping Address zip of the object. |
sic |
String | SIC of the object. |
site |
String | Site of the object. |
tickerSymbol |
String | Ticker Symbol of the object. |
type |
String | Type of the object. |
website |
String | Website of the object. |
createdAt |
DateTime | Creation time of the object. |
updatedAt |
DateTime | Last update time of the object. |
createdById |
Integer | ID of the user who created this object. |
updatedById |
Integer | ID of the user who last updated this object. |
assignedToId |
Integer | ID of the user who the object record is assigned to. |
createdBy |
User | User object representing the user who created this object. See documentation for User for fields. |
updatedBy |
User | User object representing the user who last updated this object. See documentation for User for fields. |
assignedTo |
User | User 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:
GET /api/v5/objects/prospect-accounts/101?fields=id,name,isDeleted
Host: pi.pardot.com
Authorization: Bearer <access-token>
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": 101,
"name": "Conference Venues",
"isDeleted": "false"
}
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:
GET /api/v5/objects/prospect-accounts?fields=id,name,isDeleted&orderBy=id
Host: pi.pardot.com
Authorization: Bearer <access-token>
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"values": [
{
"id": 101,
"name": "Conference Venues",
"isDeleted": "false"
}
]
}
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.
Parameter | Description |
---|---|
id |
Returns any prospect accounts where ID is equal to the given integer value. |
idGreaterThan |
Returns any prospect accounts where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo |
Returns any prospect accounts where ID is greater than or equal to the specified value. |
idLessThan |
Returns any prospect accounts where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo |
Returns any prospect accounts where ID is less than or equal to the specified value. |
Example request:
GET /api/v5/objects/prospect-accounts?fields=id,name&orderBy=id desc&idGreaterThan=200&idLessThan=300
Host: pi.pardot.com
Authorization: Bearer <access-token>
Example response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"values": [
{
"id": 225,
"name": "Prospect Account 2"
},
{
"id": 207,
"name": "Prospect Account 1"
}
]
}