List Merge Fields
mailchimp.list_merge_fields
ActionEmailconnection required
Calls the Mailchimp API with the connection's credentials.
Fetch an audience's merge fields. Each row carries the merge tag ('FNAME'), its name, type and whether it is required — the keys a member write may set in 'merge_fields'.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Mailchimp
- Secret shape
- the Mailchimp API key (…-<dc>)
- Config it needs
- dc
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 1 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 |
|---|---|---|---|---|---|
list_id The audience (list) id, as shown in Mailchimp under Audience settings and returned as 'id' by Mailchimp: List Audiences. | string | Yes | — | — | — |
required_only Return only the merge fields Mailchimp requires on this audience. | boolean | No | — | — | — |
count How many records to return on this page; Mailchimp caps a page at 1000. | number | No | 10 | 1–1000 | — |
offset How many records to skip before this page, for paging through a collection. | number | No | 0 | ≥ 0 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"count": 10,
"offset": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, exactly as Mailchimp returned them. | array | — |
count How many records this page carried. | number | — |
total Total records matching the query, from the response's total_items; falls back to the page's own row count when Mailchimp reports no total. | number | — |
{
"count": 0,
"items": [],
"total": 0
}See List Merge Fields run in a workflow.
In a technical demo we add the Mailchimp connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.