List all contact goal list entries

get

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

A contact goal list entry records one list the contact was on when it reached an automation goal. Each reached goal gets one entry for every list the contact belonged to at that moment, whatever the subscription status. Filter by list 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

filters[listid]

integer

Return only entries for this list id. Exact match.

filters[subscribergoalid]

integer

Return only entries for this reached goal, the id from GET /contactGoals/{id}. Exact match.

orders[listid]

string

enum

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

Allowed:

orders[subscribergoalid]

string

enum

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

Allowed:

limit

integer

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

offset

integer

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

ids

string

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

Response

200A page of entries under contactGoalLists, with the number of matching entries in meta.total. contactGoalLists is an empty array when there are none.