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.

Supported Operations

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

Fields

Read-Only Fields

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.

Read

Retrieve a single Tagged Object following the conventions described in the Version 5 Overview.

Example Request:

1GET /api/v5/objects/tagged-object/5000?fields=id,tagId,objectName,objectType
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example Response:

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "id": 5500,
5    "tagId": 344,
6    "objectName": "Athenasius Alexander",
7    "objectType": "prospect"
8}

Query

Retrieving a collection of tagged objects follows the conventions described in Version 5 Overview.

Example Request:

1GET /api/v5/objects/tagged-objects?fields=id,objectName,objectType,tagId
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example Response:

1HTTP/1.1 200 OK
2Content-Type: application/json
3"values": [
4    {
5        "id": 6000,
6        "createdById": 540,
7        "objectId": 450,
8        "objectName": "Standard Form",
9        "objectType": "form",
10        "tagId": 100
11    },
12    {
13        "id": 7500,
14        "createdById": 540,
15        "objectId": 451,
16        "objectName": "Contact Us",
17        "objectType": "landing-page",
18        "tagId": 101
19    },
20]

Sortable Fields

To sort queries, include the orderBy parameter. This table lists possible values for the orderBy parameter. See the conventions for query described in the Version 5 Overview.

Parameter	Description
`id`	The ID of the tagged object.
`createdAt`	The date and time when the tagged object record was created. The time zone for this property is based on the time zone of the API user.

Filtering Results

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.