Get Audience
mailchimp.get_list
ActionEmailconnection required
Calls the Mailchimp API with the connection's credentials.
Fetch one audience with its settings, campaign defaults and member counts.
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
1 field, 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 | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The audience id, used as 'list_id' by every member node. | string | — |
web_id The id this audience has in the Mailchimp web UI's URLs. | number | — |
name The audience name. | string | — |
contact The physical mailing address shown in this audience's footer. | object | — |
permission_reminder The reminder text shown to this audience. | string | — |
campaign_defaults Default from_name, from_email, subject and language. | object | — |
date_created When the audience was created, ISO 8601. | string | — |
email_type_option Whether members may choose html or plain text. | boolean | — |
double_optin Whether new members must confirm by email. | boolean | — |
stats Member counts and engagement rates for the audience. | object | — |
{
"campaign_defaults": {},
"contact": {},
"date_created": "",
"double_optin": false,
"email_type_option": false,
"id": "",
"name": "",
"permission_reminder": "",
"stats": {},
"web_id": 0
}See Get Audience 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.