Folder Contents Object

View all objects contained within Folders.

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

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

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/folder-contents/<id>?<params>Admin > Folders > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/folder-contents?<params>Admin > Folders > View ability
FieldTypeDescription
idIntegerID of the folder content storing the folder-to-object relationship.
folderIdIntegerID of the folder containing the object with objectId below.
folderRefStringThe URL for reading the specific folder with folderId above.
objectTypeEnumType of object referenced by objectId below. See Folder Contents Object Type Enum below.
objectIdIntegerID of the object contained in the folder.
objectNameStringName of the object contained in the folder.
objectRefStringThe URL for reading the specific object with objectId above.
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.
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.

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

Example request:

Example response:

When executing a query for Folder Contents, use these parameters to filter the results. Specify parameters 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 folder contents where ID is equal to the given integer value.
idListReturns any folder contents where ID is included in the given list of values.
idGreaterThanReturns any folder contents where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any folder contents where ID is greater than or equal to the specified value.
idLessThanReturns any folder contents where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any folder contents where ID is less than or equal to the specified value.
folderIdReturns any folder contents where folderId is equal to the given integer value.
objectTypeReturns any folder contents where objectType is equal to the given string value.
objectIdReturns any folder contents where objectId is equal to the given integer value.
objectNameReturns any folder contents where objectName is equal to the given string value.
createdByIdReturns any folder contents where createdById is equal to the given integer value.
updatedByIdReturns any folder contents where updatedById is equal to the given integer value.
createdAtReturns any folder contents where createdAt is equal to the given datetime value.
createdAtAfterReturns any folder contents where createdAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any folder contents where createdAt is after or equal to the given datetime value.
createdAtBeforeReturns any folder contents where createdAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any folder contents where createdAt is before or equal to the given datetime value.
updatedAtReturns any folder contents where updatedAt is equal to the given datetime value.
updatedAtAfterReturns any folder contents where updatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any folder contents where updatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any folder contents where updatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any folder contents where updatedAt is before or equal to the given datetime value.
deletedDetermines whether to return deleted records. The value can be false (default), true, or all.

Example request:

Example response: