List Members
mailchimp.list_members
ActionEmailconnection required
Calls the Mailchimp API with the connection's credentials.
Fetch a page of an audience's members, optionally limited to one status or to members changed within a time window.
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
9 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 | — | — | — |
status Return only members with this status. Leave empty for every status except archived, which Mailchimp only returns when asked for. | string | No | — | one of "subscribed", "unsubscribed", "cleaned", "pending", "transactional", "archived" | — |
since_last_changed Return only members changed at or after this time, ISO 8601. | string | No | — | iso8601 format | — |
before_last_changed Return only members changed before this time, ISO 8601. | string | No | — | iso8601 format | — |
vip_only Return only members marked VIP. | boolean | No | — | — | — |
sort_field Which timestamp to order the page by. | string | No | — | one of "timestamp_opt", "timestamp_signup", "last_changed" | — |
sort_dir Order the page ascending or descending. | string | No | — | one of "ASC", "DESC" | — |
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 Members 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.