Retrieves information about the list or lists targeted by a send.
Syntax
RetrieveLists(searchCriteria)
Function Properties
The RetrieveLists() function has the properties listed in this table.
| Property | Type | Description |
|---|---|---|
searchCriteria |
Object | Required. Criteria used to search for triggered send. |
The searchCriteria object has the properties listed in this table.
| Name | Type | Description |
|---|---|---|
property |
String | Required. The name of the field to use in the comparison. |
simpleOperator |
String | Required. The comparison operator to use in the query. Possible values are: <ul><li>equal</li><li>notEqual</li><li>lessThan</li><li>lessThanOrEqual</li><li>greaterThan</li><li>greaterThanOrEqual</li><li>like</li><li>isNull</li><li>isNotNull</li><li>contains</li><li>mustContain</li><li>startsWith</li><li>in</li></ul> |
value |
String, number, boolean, or array | The value to compare the specified field to. |
Example
To use the RetrieveLists() function, include a filter that restricts the results to the ID of a send or multiple sends. This example shows how to retrieve the lists targeted by a single send.
var listsSentTo = Send.RetrieveLists({
Property: "SendID",
SimpleOperator: "equals",
Value: 12345,
});