Use tagObject 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. Learn more about tags in Salesforce Help.
Include the authentication header with every request. For information on how to authenticate, see Authentication.
Note
| Resource Name | Operation | Description |
|---|---|---|
| TagObject Query | GET | Request information for the tagObjects that matches the specified criteria. |
| TagObject Read | GET | Request information for a single tagObject. |
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.
1/api/tagObject/version/4/do/query?...Use these parameters to specify the tagObjects to return. Parameters can be used in any combination and in any order unless otherwise specified.
Notes:
yyyy-mm-dd:hh:ss:mm).| Parameter | Type | Possible Values | Description |
|---|---|---|---|
created_after | string | today, 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_before | string | today, 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_than | integer | Any positive integer | Request tagObjects that have an ID greater than the specified number. |
id_less_than | integer | Any positive integer | Request tagObjects that have an ID less than the specified number. |
tag_id | integer | Any positive integer | Request tagObjects with the specified tag id. |
type | Automation, 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 Content | Any positive integer | Request tagObjects with the specified type. |
object_id | integer | Any positive integer | Request tagObjects with the specified object id. Must be used together with the type parameter. |
Use these parameters to specify the tagObject fields to return, and how the tagObjects are sorted.
| Parameter | Type | Possible Values | Description |
|---|---|---|---|
limit | integer | Any integer from 1 through 200. | The number of tagObjects to return. Default value is 200. |
offset | integer | Any positive integer | The 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_by | string | created_at, updated_at | The field by which the results are sorted. See Sort Order. |
sort_order | string | ascending, descending | The sort order. The default value depends on which sort_by parameter you specify. See Sort Order. |
Use sort_by to specify which field Account Engagement uses to sort the results. Different fields have different default sort orders.
| Value | Default Sort Order | Description |
|---|---|---|
created_at | descending | Sort the results by the tagObjects’ created_at timestamps. |
id | ascending | Sort the results by the tagObjects’ id fields. |
Request information for a single tagObject.
1/api/tagObject/version/4/do/read/id/<ID>Replace <ID> with the Account Engagement ID of the tagObject.
Request information about the tagObject with ID 1234.
1/api/tagObject/version/4/do/read/id/1234The XML response for a query request contains information for multiple tagObjects. The XML response for a read request contains information for a single tagObject.
1<rsp stat="ok" version="1.0">
2 <result>
3 <total_results>...</total_results>
4 <tagObject>...</tagObject>
5 <tagObject>...</tagObject>
6 <tagObject>...</tagObject>
7 </result>
8</rsp>| Tag | Description |
|---|---|
<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. |
1<?xml version="1.0" encoding="UTF-8"?>
2<rsp stat="ok" version="1.0">
3 <tagObject>
4 <id>1234</id>
5 <tag_id>4567</tag_id>
6 <type>Prospect</type>
7 <object_id>1000</object_id>
8 <created_at>2020-10-15 10:09:22</created_at>
9 </tagObject>
10</rsp>| Tag | Description |
|---|---|
<tagObject> | The information about a single tagObject. See TagObject in Object Field References for a description of fields. |
j