Tagged Object
Use Tagged Object resources to learn more about the Account Engagement objects that are tagged. Discover the type and ID of the tagged objects, the tag ID, and the time the tag was applied.
The API to access the Tagged Object follows the conventions described in Version 5 Overview.
| Operation | HTTP Verb | URL Format | Ability Requirements |
|---|---|---|---|
| Read | GET | https://pi.pardot.com/api/v5/objects/tagged-objects/<id>?<params> | Marketing > Segmentation > Tags > View |
| Query | GET | https://pi.pardot.com/api/v5/objects/tagged-objects?<params> | Marketing > Segmentation > Tags > View |
| Field | Type | Description |
|---|---|---|
id | Integer | The ID of the tagged object. |
tagId | Integer | The ID of the tag. |
objectType | Enum | The object type of the tagged object. |
objectId | Integer | The ID of the tagged object. |
objectName | String | The name of the tagged object. |
createdAt | DateTime | The date and time when the tag was added to the object. |
createdById | Integer | The ID of the user who added the tag to the object. |
createdBy | User | An object that represents the user who created the object. |
tag | Tag | An object that represents the tag associated with the object. |
Retrieve a single Tagged Object following the conventions described in the Version 5 Overview.
Example Request:
Example Response:
Retrieving a collection of tagged objects follows the conventions described in Version 5 Overview.
Example Request:
Example Response:
To sort queries, include the orderBy parameter. You can sort by the id field, which corresponds to the ID of the tagged object. See the conventions for query described in the Version 5 Overview.
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.
| Parameter | Description |
|---|---|
id | Returns any tagged object where ID is equal to the given integer value. |
idList | Returns any tagged object where ID is included in the given list of values. |
idGreaterThan | Returns any tagged object where ID is greater than the specified value, non-inclusive. |
idGreaterThanOrEqualTo | Returns any tagged object where ID is greater than or equal to the specified value. |
idLessThan | Returns any tagged object where ID is less than the specified value, non-inclusive. |
idLessThanOrEqualTo | Returns any tagged object where ID is less than or equal to the specified value. |
tagId | Returns any tagged object where tagId is equal to the given tagId |
objectType | Returns any tagged object where objectType is equal to the given objectType |
objectId | Returns any tagged object where objectId is equal to the given objectId |
objectName | Returns any tagged object where objectName is equal to the given objectName |
createdAt | Returns any tagged object where CreatedAt is equal to the given datetime value. |
createdAtAfter | Returns any tagged object where CreatedAt is after the given datetime value, non-inclusive. |
createdAtAfterOrEqualTo | Returns any tagged object where CreatedAt is after or equal to the given datetime value. |
createdAtBefore | Returns any tagged object where CreatedAt is before the given datetime value, non-inclusive. |
createdAtBeforeOrEqualTo | Returns any tagged object where CreatedAt is before or equal to the given datetime value. |
- campaign
- custom-field
- custom-redirect
- dynamic-content
- email-template
- file
- form-field
- form-handler
- form
- landing-page
- layout-template
- list
- prospect
- user