Looking for version 4?

Querying Prospect Accounts

Supported Operations

Operation URL Format Required Parameters Description
query /api/prospectAccount/version/3/do/query?... user_key, api_key Returns the prospect accounts matching the specified criteria parameters. See the Using Prospect Accounts section for a complete description of the prospect account XML Response Format. Also see Prospect Account in Object Field References.

Supported Search Criteria

Search criteria may be used together in any combination and/or order unless otherwise specified. Unless output=mobile is specified, 200 prospect accounts will be returned with each query request. This limit is not enforced for responses formatted for mobile devices.

Parameter Datatype Options Description
created_after string today, yesterday, last_7_days, this_month, last_month, <custom_time> Searches for prospect accounts that were created after the specified time. If a <custom_time> is used, ensure that the specified date is formatted using GNU Date Input Syntax.
created_before string today, yesterday, last_7_days, this_month, last_month, <custom_time> Searches for prospect accounts that were created before the specified time. If a <custom_time> is used, ensure that the specified date is formatted using GNU Date Input Syntax.
id_greater_than integer <any_positive_integer> Searches for prospect accounts with IDs greater than the specified integer.
id_less_than integer <any_positive_integer> Searches for prospect accounts with IDs less than the specified integer.
name string <any string> Searches for prospect accounts a name exactly matching the given name.
updated_before string today, yesterday, last_7_days, this_month, last_month, <custom_time> Searches for prospect accounts that were updated before the specified time. If a <custom_time> is used, ensure that the specified date is formatted using GNU Date Input Syntax.
updated_after string today, yesterday, last_7_days, this_month, last_month, <custom_time> Searches for prospect accounts that were updated after the specified time. If a <custom_time> is used, ensure that the specified date is formatted using GNU Date Input Syntax.

Manipulating the Result Set

Since query result sets are limited to 200 results each, the results returned may not include all the prospect accounts matched by the query. To retrieve the remaining results, the following criteria can be used to navigate through the result set.

Parameter Datatype Options Description
fields array <comma_separated_field_ids> Specifies the fields to be returned. Note: All default and custom fields will be returned by default; <id> will always be returned.
limit integer <any_positive_integer> Specifies the number of results to be returned. Default value: 200. Note: This number cannot be larger than 200. If a number larger than 200 is specified, 200 will be used.
offset integer <any_positive_integer> Specifies the first matching prospect account (according to the specified sorting order) to be returned in the query response. The first offset matching prospect accounts will be omitted from the response. Default value: 0. Example: Specifying offset=10 will return the results starting with the 11th prospect account matched by the provided criteria.
sort_by string created_at, id, name, updated_at Specifies the field that should be used to sort the results of the query. See Supported Sorting Options for more details. Default value: id.
sort_order string ascending, descending Specifies the ordering to be used when sorting the results of the query. The default value varies based on the value of the sort_by parameter. See Supporting Sorting Options for more details.

Supported Sorting Options

The ordering of the results returned by a query request can be changed by specifying sort_by and sort_order parameters. Any of the following values are valid when specifying the sort_by parameter. For a complete list of fields involved in prospect account queries, see Prospect Account in Object Field References.

Value Default Sort Order Description
created_at descending Specifies that the query results should be sorted by the prospect accounts' created_at timestamps.
id ascending Specifies that the query results should be sorted by the prospect accounts' id fields.
name ascending Specifies that the query results should be sorted by the prospect accounts' updated_at names.
updated_at ascending Specifies that the query results should be sorted by the prospect accounts' updated_at timestamps.

XML Response Format

<rsp stat="ok" version="1.0">
    <result>
        <total_results>...</total_results>
        <prospectAccount>...</prospectAccount>
        <prospectAccount>...</prospectAccount>
        <prospectAccount>...</prospectAccount>
    </result>
</rsp>
Tag Description
<result> Contains the resulting prospect accounts for the specified query.
<total_results> Contains the number of prospect accounts selected by this query. If this value is higher than 200, then several query requests may be necessary to retrieve all of the matched prospect accounts.
<prospectAccount> The data for an individual prospect account. See Using Prospect Accounts for a complete description of the prospect account XML Response Format. Also see Prospect Account in Object Field References.

Using Prospect Accounts

Supported Operations

For a complete list of fields involved in user operations, see the Prospect Account section of Object Field References.

Operation URL Format Required Parameters Description
create /api/prospectAccount/version/3/do/create?... user_key, api_key Create a new prospect account.
describe /api/prospectAccount/version/3/do/describe?... user_key, api_key Returns the field metadata for prospect accounts, explaining what fields are available, their types, whether they are required, and their options (for dropdowns, radio buttons, etc)
read /api/prospectAccount/version/3/do/read/id/<id>?... user_key, api_key, id Returns the data for the prospect account specified by <id>. <id> is the Pardot ID of the target prospect account.
update /api/prospectAccount/version/3/do/update/id/<id>?... user_key, api_key, id Update the data for the prospect account specified by <id>. <id> is the Pardot ID of the target prospect account.

XML Response Format

<rsp stat="ok" version="1.0">
    <prospectAccount>
        <id>1234</id>
        <name>Acme, Inc.</name>
        <created_at>2012-03-21 17:20:30</created_at>
        <updated_at>2012-05-15 09:57:11</updated_at>
    </prospectAccount>
</rsp>
Tag Description
<prospectAccount> Parent tag. Contains data fields for target prospect account. For complete field listing, see Prospect Account in Object Field References.