RetrieveLists

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.

PropertyTypeDescription
searchCriteriaObjectRequired. Criteria used to search for triggered send.

The searchCriteria object has the properties listed in this table.

NameTypeDescription
propertyStringRequired. The name of the field to use in the comparison.
simpleOperatorStringRequired. The comparison operator to use in the query. Possible values are:
  • equal
  • notEqual
  • lessThan
  • lessThanOrEqual
  • greaterThan
  • greaterThanOrEqual
  • like
  • isNull
  • isNotNull
  • contains
  • mustContain
  • startsWith
  • in
valueString, number, boolean, or arrayThe 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.

1var listsSentTo = Send.RetrieveLists({
2  Property: "SendID",
3  SimpleOperator: "equals",
4  Value: 12345,
5});