Magento REST icon

Magento REST

Consume Magento REST API

Customer → List

AI-generated

Summary

list customers with searchCriteria support

Inputs

  • resource (required) — Set to 'customer' for this operation
  • operation (required) — Set to 'list' to select the list operation

Output shape

object containing Magento customer(s) data returned from the REST API. When simplifyOutput is enabled, the response is flattened: custom_attributes array becomes an object, extension_attributes are flattened into top-level keys, and nested structures are simplified.

The node returns an array of customer records; each record's structure depends on the Magento API response and the simplifyOutput setting.

Examples

Example 1: List all customers with default pagination and no filtering

Leave searchCriteria empty; pageSize and currentPage use defaults (20 and 1).

Example 2: List customers filtered by email, sorted by created_at descending, simplified output

searchCriteria.filterGroups[0].filters[0].field = 'email', conditionType = 'like', value = '$emailParam'; sortOrders[0].field = 'created_at', direction = 'DESC'; simplifyOutput = true.

Links

Discussion