ssjs.guide SFMC

LookupRows

→ object[]

Returns all rows from a Data Extension matching the filter criteria as an array of objects.

Available in: Email CloudPage Automation Triggered Send

Syntax

Platform.Function.LookupRows(deName, filterField, filterValue [, filterField2, filterValue2, ...])
3+ arguments

Parameters

Name Type Required Description
deName string Yes Data Extension name or external key
filterField string Yes Column name to filter on
filterValue string Yes Value to match in the filter column
filterField2 string No Additional filter column (AND logic)
filterValue2 string No Additional filter value

Description

LookupRows returns an array of row objects from the specified Data Extension. Each element in the array is an object where property names are the column names and values are the cell values.

Returns an empty array [] when no rows match (not null).

Unlike DataExtension.Rows.Retrieve(), LookupRows works correctly on CloudPages.

Row limit: LookupRows may return up to 2,000 rows by default. Use LookupOrderedRows with a sortCount limit for larger datasets.

Examples

Basic multi-row lookup

var rows = Platform.Function.LookupRows("ActiveSubscribers", "Status", "active");

Write("<p>Found " + rows.length + " subscribers</p>");
Write("<ul>");
for (var i = 0, len = rows.length; i < len; i++) {
    var row = rows[i];
    Write("<li>" + row["Email"] + " — " + row["FirstName"] + "</li>");
}
Write("</ul>");

Multi-column filter

var rows = Platform.Function.LookupRows(
    "Orders",
    "Status",  "pending",
    "Country", "US"
);

for (var i = 0; i < rows.length; i++) {
    var order = rows[i];
    Write(order["OrderID"] + ": " + order["Total"] + "<br>");
}

Check if empty

var results = Platform.Function.LookupRows("Products", "Category", selectedCategory);

if (results.length === 0) {
    Write('<p class="empty">No products found in this category.</p>');
} else {
    // render products...
}

Build a select dropdown

var options = Platform.Function.LookupRows("Countries", "Active", "1");

Write('<select name="country">');
for (var i = 0, len = options.length; i < len; i++) {
    Write('<option value="' + options[i]["Code"] + '">' + options[i]["Name"] + '</option>');
}
Write('</select>');

Accessing row fields

Row fields are accessed by column name (case-sensitive to the DE column names):

var row = rows[0];
var id    = row["ID"];          // or row.ID if no spaces
var email = row["Email"];
var date  = row["CreatedDate"];

Notes

  • Works on CloudPages (unlike DataExtension.Rows.Retrieve())
  • Returns all matching rows up to SFMC’s row limit
  • Results are not guaranteed to be in any particular order — use LookupOrderedRows for sorted results
  • Accessing a non-existent column returns undefined

See Also

See Also