TagObject Object

Use tagObject resources to learn more about the Pardot objects that are tagged. Discover the type and ID of the tagged objects, the tag ID, and the time the tag was applied. Learn more about tags in Salesforce Help.

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

TagObject Resources

Resource NameOperationDescription
TagObject QueryGETRequest information for the tagObjects that matches the specified criteria.
TagObject ReadGETRequest information for a single tagObject.

TagObject Query

Request information for the tagObjects that match the specified criteria. You can specify the tagObjects and fields to request. A maximum of 200 records are returned. To return all tagObjects, specify the output as mobile.

URI

Parameters to Select TagObject Records

Use these parameters to specify the tagObjects to return. Parameters can be used in any combination and in any order unless otherwise specified.

Notes:

ParameterTypePossible ValuesDescription
created_afterstringtoday, yesterday, last_7_days, this_month, last_month,<custom_time>Request tagObjects created after the specified time. Example: To request forms created in 2020, use /api/tagObject/version/4/do/query?created_after=2019-12-31 24:59:59.
created_beforestringtoday, yesterday, last_7_days, this_month, last_month, <custom_time>Request tagObjects created before the specified time. Doesn’t include tagObjects created at the specified time. Example: To request tagObjects created before today (but not created today), use /api/tagObject/version/4/do/query?created_before=today.
id_greater_thanintegerAny positive integerRequest tagObjects that have an ID greater than the specified number.
id_less_thanintegerAny positive integerRequest tagObjects that have an ID less than the specified number.
tag_idintegerAny positive integerRequest tagObjects with the specified tag id.
typeAutomation, Block, Campaign, Competitor, Prospect Custom Field, Custom URL, Drip Program, Email, Email Draft, Email Template, Email Template Draft, File, Form, Form Field, Form Handler, Group, Keyword, Landing Page, Layout Template, List, Opportunity, Paid Search Campaign, Personalization, Profile, Prospect, Prospect Default Field, Segmentation Rule, Site, Site Search, Social Message, User, Dynamic ContentAny positive integerRequest tagObjects with the specified type.
object_idintegerAny positive integerRequest tagObjects with the specified object id. Must be used together with the type parameter.

Parameters to Specify Which Results Are Returned

Use these parameters to specify the tagObject fields to return, and how the tagObjects are sorted.

ParameterTypePossible ValuesDescription
limitintegerAny integer from 1 through 200.The number of tagObjects to return. Default value is 200.
offsetintegerAny positive integerThe number of tagObjects to omit from the response (the number to "skip over"). Example: Retrieve a list of tagObjects, omitting the 50 most recently updated records. Sort the query by the id field and use offset=50: /api/tagObject/version/4/do/query?sort_by=id&offset=50
sort_bystringcreated_at, updated_atThe field by which the results are sorted. See Sort Order.
sort_orderstringascending, descendingThe sort order. The default value depends on which sort_by parameter you specify. See Sort Order.

Sort Order

Use sort_by to specify which field Pardot uses to sort the results. Different fields have different default sort orders.

ValueDefault Sort OrderDescription
created_atdescendingSort the results by the tagObjects' created_at timestamps.
idascendingSort the results by the tagObjects' id fields.

TagObject Read

Request information for a single tagObject.

URI

Replace <ID> with the Pardot ID of the tagObject.

Example

Request information about the tagObject with ID 1234.

XML Response

The XML response for a query request contains information for multiple tagObjects. The XML response for a read request contains information for a single tagObject.

XML Response for a TagObject Query

TagDescription
<result>Parent tag. Contains information about the tagObjects that match the parameters specified in your query.
<total_results>Contains the number of tagObjects selected by the query. Note The query request returns a maximum of 200 tagObjects. If your query matches more than 200 records, you can make several requests to retrieve all matching records.
<tagObject>The information about a single tagObject. See TagObject in Object Field References for a complete description of fields.

XML Response for a TagObject Read

TagDescription
<tagObject>The information about a single tagObject. See TagObject in Object Field References for a description of fields.