List Segments
mautic.list_segments
ActionCRM & salesconnection required
Calls the Mautic API with the connection's credentials.
Search and page the segments defined in Mautic.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Mautic
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 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 |
|---|---|---|---|---|---|
search Mautic search string or search command, for example 'email:*@acme.com'. | string | No | — | — | — |
start Row to start from; 0 is the first record of the result set. | number | No | 0 | ≥ 0 | — |
limit How many records to return in one call; Mautic's own default is 30. | number | No | 30 | ≥ 1 | — |
order_by Column to sort by, written as Mautic stores it, for example 'date_modified'. | string | No | — | — | — |
order_by_dir Sort direction for 'order_by'. | string | No | — | one of "ASC", "DESC" | — |
published_only Return only records that are currently published in Mautic. | boolean | No | — | — | — |
minimal Return each record without its nested lists, which is much cheaper on large accounts. | boolean | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 30,
"start": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
records The records on this page, as Mautic returned them. | array | — |
returned How many records this page contains. | number | — |
total How many records match the query in total. | number | — |
{
"records": [],
"returned": 0,
"total": 0
}See List Segments run in a workflow.
In a technical demo we add the Mautic connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.