Campaign Object

A Pardot campaign tracks the first interaction that a person has with your online marketing materials. Associate your assets to a Pardot campaign to organize and track your marketing efforts. Learn more about Pardot campaigns in Salesforce Help.

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

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

Campaign Resources

OperationVerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/campaigns/<id>?<params>Marketing > Other > Campaigns > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/campaigns?<params>Marketing > Other > Campaigns > View ability

Fields

Read-Only Fields

FieldTypeDescription
idIntegerID of the object.
nameStringName of the object for identification in Pardot.
isDeletedBooleanTrue if the object is in the recycle bin in Pardot.
folderIdIntegerID of the folder containing this object.
costFloatCost of the campaign object.
parentCampaignIdIntegerThe ID of the parent campaign.
createdByIdIntegerID of the individual who created this object.
updatedByIdIntegerID of the individual who last updated this object.
createdAtDateTimeThe timestamp of when this object was created.
updatedAtDateTimeThe timestamp of when this object was last updated.
salesforceIdStringThe alpha-numeric Id of the Salesforce Org.
folderFolderJSON object representing the folder for this object. See documentation for folder for fields.
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.
parentCampaignCampaignCampaign object representing the parent campaign for this campaign. See documentation for Campaign for fields.

Campaign Read

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

Example request:

Example response:

Campaign Query

Retrieving a collection of campaigns 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
  • 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 campaigns where ID is equal to the given integer value.
idGreaterThanReturns any campaigns where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any campaigns where ID is greater than or equal to the specified value.
idLessThanReturns any campaigns where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any campaigns where ID is less than or equal to the specified value.
nameReturns any campaigns where Name is equal to the given string value.
createdAtReturns any campaigns where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any campaigns where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any campaigns where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any campaigns where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any campaigns where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any campaigns where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any campaigns where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any campaigns where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any campaigns where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any campaigns where UpdatedAt is before or equal to the given datetime value.

Example request:

Example response: