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.
Operation | HTTP Verb | URL Format | Ability Requirements |
---|---|---|---|
Read | GET | https://pi.pardot.com/api/v5/objects/folder-contents/<id>?<params> | Admin > Folders > View ability |
Query | GET | https://pi.pardot.com/api/v5/objects/folder-contents?<params> | Admin > Folders > View ability |
Field | Type | Description |
---|---|---|
id | Integer | ID of the folder content storing the folder-to-object relationship. |
folderId | Integer | ID of the folder containing the object with objectId below. |
folderRef | String | The URL for reading the specific folder with folderId above. |
objectType | Enum | Type of object referenced by objectId below. See Folder Contents Object Type Enum below. |
objectId | Integer | ID of the object contained in the folder. |
objectName | String | Name of the object contained in the folder. |
objectRef | String | The URL for reading the specific object with objectId above. |
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. |
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.
Parameter | Description |
---|---|
id | Returns any folder contents where ID is equal to the given integer value. |
idList | Returns any folder contents where ID is included in the given list of values. |
idGreaterThan | Returns any folder contents where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any folder contents where ID is greater than or equal to the specified value. |
idLessThan | Returns any folder contents where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any folder contents where ID is less than or equal to the specified value. |
folderId | Returns any folder contents where folderId is equal to the given integer value. |
objectType | Returns any folder contents where objectType is equal to the given string value. |
objectId | Returns any folder contents where objectId is equal to the given integer value. |
objectName | Returns any folder contents where objectName is equal to the given string value. |
createdById | Returns any folder contents where createdById is equal to the given integer value. |
updatedById | Returns any folder contents where updatedById is equal to the given integer value. |
createdAt | Returns any folder contents where createdAt is equal to the given datetime value. |
createdAtAfter | Returns any folder contents where createdAt is after the given datetime value, non-inclusive. |
createdAtAfterOrEqualTo | Returns any folder contents where createdAt is after or equal to the given datetime value. |
createdAtBefore | Returns any folder contents where createdAt is before the given datetime value, non-inclusive. |
createdAtBeforeOrEqualTo | Returns any folder contents where createdAt is before or equal to the given datetime value. |
updatedAt | Returns any folder contents where updatedAt is equal to the given datetime value. |
updatedAtAfter | Returns any folder contents where updatedAt is after the given datetime value, non-inclusive. |
updatedAtAfterOrEqualTo | Returns any folder contents where updatedAt is after or equal to the given datetime value. |
updatedAtBefore | Returns any folder contents where updatedAt is before the given datetime value, non-inclusive. |
updatedAtBeforeOrEqualTo | Returns any folder contents where updatedAt is before or equal to the given datetime value. |
deleted | Determines whether to return deleted records. The value can be false (default), true , or all . |
Example request:
Example response:
- Automation Rules
- Campaign
- Custom Redirect
- Drip Program
- Dynamic Content
- Email Draft
- Email Template
- Email Template Draft
- Engagement Studio Program
- File
- Folder
- Form
- Form Handler
- Landing Page
- Layout Template
- List
- Multivariate Test