Search Customers
magento.search_customers
ActionBusiness appsconnection required
Calls the Magento API with the connection's credentials.
Search customer accounts with Magento's searchCriteria filters and return one page of matches.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Magento
- Secret shape
- the integration access token, or {"access_token": "…"}
- Config it needs
- base_url, store_code
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
filters Search filters. Each entry is an object with 'field', 'value' and an optional 'condition_type' (eq, neq, like, in, gt, lt, gteq, lteq, from, to, null, notnull). Entries listed side by side are combined with AND; nest a list inside the list to OR those filters together. | array | No | — | array of any | — |
sort_field Attribute code to sort the page by, for example 'created_at' or 'entity_id'. | string | No | — | — | — |
sort_direction Sort direction applied to 'sort_field'. | string | Conditional | ASC | one of "ASC", "DESC"; only with sort_field | — |
page_size How many records to return in this page. Magento's own default is 20 and a store can cap the maximum lower than the 300 allowed here. | number | No | 20 | 1–300 | — |
current_page Which page of the result set to return, counting from 1. | number | No | 1 | 1–1000000 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"current_page": 1,
"page_size": 20,
"sort_direction": "ASC"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, exactly as Magento returned them. | array | — |
count How many records are on this page. | number | — |
total_count How many records match the search across every page. | number | — |
search_criteria The criteria Magento echoed back for this page. | object | — |
has_more True when a further page of results is still waiting. | boolean | — |
{
"count": 0,
"has_more": false,
"items": [],
"search_criteria": {},
"total_count": 0
}See Search Customers run in a workflow.
In a technical demo we add the Magento connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.