Folder Object

Organize and nest your content and marketing assets in a way that makes sense for your team. Learn about folders in Salesforce Help.

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

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

Folder Resources

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/folders/<id>?<params>Admin > Folders > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/folders?<params>Admin > Folders > View ability

Fields

Read-Only Fields

FieldTypeDescription
idIntegerID of the object.
nameStringThe name of the folder.
parentFolderIdIntegerID of the folder containing this folder. This value is null when the folder is a root folder and doesn't have a parent.
pathStringThe names of each folder from the root folder separated with forward slashes (/).
usePermissionsBooleanTrue if the folder is configured to use permissions.
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.
parentFolderFolderJSON object representing the folder for this object. See documentation for Folder for fields.

Folder Query

Folders let you organize your content and apply permissions to control who can access your assets. Learn more about folders in Salesforce Help.

Retrieving a collection of folders 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

Filtering Results

When executing a query for folders, 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 folders where ID is equal to the given integer value.
idGreaterThanReturns any folders where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any folders where ID is greater than or equal to the specified value.
idLessThanReturns any folders where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any folders where ID is less than or equal to the specified value.
parentFolderIdReturns any folders where the parentFolderId is equal to the given integer value.
parentFolderIdGreaterThanReturns any folders where the parentFolderId is greater than the specified value, non-inclusive.
parentFolderIdGreaterThanOrEqualToReturns any folders where the parentFolderId is greater than or equal to the specified value.
parentFolderIdLessThanReturns any folders where the parentFolderId is less than the specified value, non-inclusive.
parentFolderIdLessThanOrEqualToReturns any folders where the parentFolderId is less than or equal to the specified value.
parentFolderIdIsNullReturns any folders where the parentFolderId is null when true is specified.
parentFolderIdIsNotNullReturns any folders where the parentFolderId isn’t null when true is specified.

Example request:

Example response