Opportunity Object

When you create a Salesforce opportunity with a contact role that’s associated with a Pardot prospect, we create a read-only opportunity in Pardot. To use Pardot opportunities, first set up the Pardot-Salesforce connector. Learn more about opportunities in Salesforce Help.

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

Supported Operations

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

Fields

Read-Only Fields

FieldTypeDescription
campaignIdIntegerPardot ID of the campaign associated with this opportunity. Information about an opportunity's campaign association can be returned using the Campaign relationship.
closedAtDateTimeThe opportunity's closed date. When left blank, the Closed Date field in Pardot isn’t set, even when the opportunity's stage, status, or probability are set to indicate that the opportunity is closed.
createdAtDateTimeTime opportunity is created in Pardot; Time is reported in API user's preferred timezone.
createdByIdIntegerID of the user who created this object.
idIntegerPardot ID for this opportunity.
nameStringThe opportunity's name
probabilityIntegerThe opportunity's probability. Must be a positive numeric value from 0 through 100, inclusive.
salesforceIdStringThe ID of the associated opportunity in Salesforce.
stageStringThe opportunity's stage.
statusStringThe opportunity's status. Status must be either won, lost, or open.
typeStringThe opportunity's type.
updatedAtDateTimeLast time opportunity was updated in Pardot; Time is reported in API user's preferred timezone.
updatedByIdIntegerID of the user who last updated this object.
valueFloatThe opportunity's value. Must be a positive numeric value.
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.
campaignCampaignCampaign object representing the campaign that was set on Create. See documentation for Campaign for fields.

Opportunity Read

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

Example request:

Example response:

Opportunity Query

Retrieve a collection of opportunities following the conventions described in the Version 5 Overview.

Example request:

Example response:

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
  • updatedAt
  • createdAt
  • closedAt

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 opportunities where ID is equal to the given integer value.
idGreaterThanReturns any opportunities where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any opportunities where ID is greater than or equal to the specified value.
idLessThanReturns any opportunities where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any opportunities where ID is less than or equal to the specified value.
createdAtReturns any opportunities where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any opportunities where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any opportunities where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any opportunities where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any opportunities where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any opportunities where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any opportunities where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any opportunities where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any opportunities where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any opportunities where UpdatedAt is before or equal to the given datetime value.
closedAtReturns any opportunities where closedAt is equal to the given datetime value.
closedAtAfterReturns any opportunities where closedAt is after the given datetime value, non-inclusive.
closedAtAfterOrEqualToReturns any opportunities where closedAt is after or equal to the given datetime value.
closedAtBeforeReturns any opportunities where closedAt is before the given datetime value, non-inclusive.
closedAtBeforeOrEqualToReturns any opportunities where closedAt is before or equal to the given datetime value.