Tag Object

Use tag resources to learn more about your Pardot tags. You can tag every asset in Pardot (including prospects and content) with keywords or key phrases. Use tags to classify, sort, and filter your Pardot information. Learn more about tags in Salesforce Help.

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

Tag Resources

Resource NameOperationDescription
Tag QueryGETRequest information for tags that match the specified criteria.
Tag ReadGETRequest information for a single tag.

Tag Query

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

URI

Parameters to Select Tags

Use these parameters to specify the tags 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 tags created after the specified time. Example: To request tags created in 2020, use /api/tag/version/3/do/query?created_after=2019-12-31 24:59:59.
created_beforestringtoday, yesterday, last_7_days, this_month, last_month, <custom_time>Request tags created before the specified time. Doesn’t include tags created at the specified time. Example: To request tags created before today (but not created today), use /api/tag/version/3/do/query?created_before=today.
id_greater_thanintegerAny positive integerRequest tags that have an ID greater than the specified number.
id_less_thanintegerAny positive integerRequest tags that have an ID less than the specified number.
namestringAny stringRequest tags that have the specified name.
updated_afterstringtoday, yesterday, last_7_days, this_month, last_month, <custom_time>Request tags that were last updated after the specified time.
updated_beforestringtoday, yesterday, last_7_days, this_month, last_month, <custom_time>Request tags that were last updated before the specified time.

Parameters to Specify Which Results Are Returned

Use these parameters to specify the tag fields to return, and how the tags are sorted.

ParameterTypePossible ValuesDescription
limitintegerAny integer from 1 through 200.The number of tags to return. Default value is 200.
offsetintegerAny positive integerThe number of tags to omit from the response (the number to "skip over"). Example: Retrieve a list of tags, omitting the 50 most recently updated records. Sort the query by the updated_at field and use offset=50: /api/tag/version/3/do/query?sort_by=updated_at&offset=50
sort_bystringcreated_at, id, 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 tags' created_at timestamps.
idascendingSort the results by the tags' id fields.
updated_atdescendingSort the results by the tags' updated_at timestamps.

Tag Read

Request information for a single tag.

URI

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

Example

Request information about the tag with ID 1234.

XML Response

The XML response for a query request contains information for multiple tags. The XML response for a read request contains information for a single tag.

XML Response for a Tag Query

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

XML Response for a Tag Read

TagDescription
<tag>Contains information about a single tag. See Tag in Object Field References for a description of fields.