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.

Note

Supported Operations

Operation	HTTP Verb	URL Format	Ability Requirements
Read	`GET`	`https://pi.pardot.com/api/v5/objects/folders/<id>?<params>`	Admin > Folders > View ability
Query	`GET`	`https://pi.pardot.com/api/v5/objects/folders?<params>`	Admin > Folders > View ability

Fields

Read-Only Fields

Field	Type	Description
`id`	Integer	ID of the object.
`name`	String	The name of the folder.
`parentFolderId`	Integer	ID of the folder containing this folder. This value is null when the folder is a root folder and doesn’t have a parent.
`path`	String	The names of each folder from the root folder separated with forward slashes (/).
`usePermissions`	Boolean	True if the folder is configured to use permissions.
`createdAt`	DateTime	Creation time of the object.
`updatedAt`	DateTime	Last update time of the object.
`createdById`	Integer	ID of the user who created this object.
`updatedById`	Integer	ID of the user who last updated this object.
`createdBy`	User	User object representing the user who created this object. See documentation for User for fields.
`updatedBy`	User	User object representing the user who last updated this object. See documentation for User for fields.
`parentFolder`	Folder	JSON 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, 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.

Parameter	Description
`id`	Returns any folders where ID is equal to the given integer value.
`idList`	Returns any folders where ID is included in the given list of values.
`idGreaterThan`	Returns any folders where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any folders where ID is greater than or equal to the specified value.
`idLessThan`	Returns any folders where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any folders where ID is less than or equal to the specified value.
`name`	Returns any folders where Name is equal to the given string value.
`parentFolderId`	Returns any folders where the `parentFolderId` is equal to the given integer value.
`parentFolderIdGreaterThan`	Returns any folders where the `parentFolderId` is greater than the specified value, non-inclusive.
`parentFolderIdGreaterThanOrEqualTo`	Returns any folders where the `parentFolderId` is greater than or equal to the specified value.
`parentFolderIdLessThan`	Returns any folders where the `parentFolderId` is less than the specified value, non-inclusive.
`parentFolderIdLessThanOrEqualTo`	Returns any folders where the `parentFolderId` is less than or equal to the specified value.
`parentFolderIdIsNull`	Returns any folders where the `parentFolderId` is null when `true` is specified.
`parentFolderIdIsNotNull`	Returns any folders where the `parentFolderId` isn’t null when `true` is specified.

Example request:

1GET /api/v5/objects/folders?fields=id,name,parentFolder.id,parentFolder.name&parentFolderId=1723
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example response:

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4  "values": [
5    {
6      "id": 9872,
7      "name": "Example Folder 1",
8      "parentFolder": {
9        "id": 1723,
10        "name": "Files"
11      }
12    },
13    {
14      "id": 10348,
15      "name": "Example Folder 2",
16      "parentFolder": {
17        "id": 1723,
18        "name": "Files"
19      }
20    }
21  ]
22}