HomeSandbox AccountsAPIApp StudioWebhooksCommunity
API

List all contact goal tag entries

get
https://{youraccountname}.api-us1.com/api/3/contactGoalTags

A contact goal tag entry records one tag the contact had when it reached an automation goal. Each reached goal gets one entry for every tag the contact had at that moment. The entries are a snapshot: they do not change when the contact's tags change later. Filter by tag or by reached goal. Without an order, entries come in no guaranteed order. Page with limit and offset, or fetch specific entries with ids.

Query Params
integer

Return only entries for this tag id. Exact match.

integer

Return only entries for this reached goal (the contactGoal id on an entry). Exact match.

string
enum

Sort by tag id. DESC, in any case, sorts high to low; any other value sorts low to high.

Allowed:
string
enum

Sort by reached goal id. DESC, in any case, sorts high to low; any other value sorts low to high.

Allowed:
integer

Number of entries to return. Defaults to 20; values above 100 are treated as 100.

integer

Number of entries to skip. Use with limit to page through the entries.

string

Comma-separated entry ids to return. When set, only those entries are returned; limit does not apply, but offset still does.

Response

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 hour ago

Did this page help you?