Mailchimp Audiences ListAudiences
CertifiedList Mailchimp audiences
Mailchimp Audiences ListAudiences
List Mailchimp audiences
Reads the audiences (lists) of the account with GET /lists.
By default every page is read (1000 per request) until maxItems or the end.
Each row exposes id, name, dateCreated, visibility, memberCount and unsubscribeCount (the latter two come from stats); every other Mailchimp field keeps its original key.
type: io.kestra.plugin.mailchimp.audiences.ListAudiencesExamples
List all audiences created this year and keep them in memory.
id: mailchimp_list_audiences
namespace: company.team
tasks:
- id: audiences
type: io.kestra.plugin.mailchimp.audiences.ListAudiences
apiKey: "{{ secret('MAILCHIMP_API_KEY') }}"
sinceDateCreated: "2026-01-01T00:00:00Z"
fetchType: FETCH
Properties
accessToken string
OAuth access token
Set exactly one of apiKey or accessToken. server is required with an access token.
apiKey string
Mailchimp API key
Set exactly one of apiKey or accessToken. The data center is taken from the key suffix (for example -us19) unless server is set.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150baseUrl string
Base URL override
Replaces https://<server>.api.mailchimp.com/3.0. The credential is sent to this URL, so it must be an https *.api.mailchimp.com host.
beforeDateCreated string
Created before
Only audiences created before this ISO-8601 date and time (sent as before_date_created).
fetchType string
STOREFETCHFETCH_ONENONEFetch strategy
FETCH_ONE: first record only.
FETCH: all records in memory.
STORE: write rows as ION to internal storage and return the URI.
NONE: only count them.
Default FETCH, except STORE for ListMembers and ListEmailActivity, which can return very many rows.
fields array
Fields
Restrict the response to these Mailchimp fields, using Mailchimp's dotted syntax, e.g. lists.id, lists.name, total_items.
includeTotalContacts booleanstring
Include total contacts
Also ask Mailchimp for the total contact count of each audience (include_total_contacts).
maxItems integerstring
Max items
Stop after this many records. Must be at least 1. Default: unlimited, so set it to bound a huge result.
maxRetries integerstring
3Max retries
Retries done by this plugin on HTTP 429 (all methods) and on 5xx or I/O errors (GET and PUT only), with exponential backoff. Default 3, between 0 and 10. Kestra's HTTP client also replays a GET or PUT once after a 429 or 503 on its own, so 0 only turns off the plugin's retries.
server string
Data center
Mailchimp data center such as us19. Required with accessToken, optional with apiKey (overrides the key suffix).
sinceDateCreated string
Created since
Only audiences created after this ISO-8601 date and time (sent as since_date_created).
timeout string
PT2MRequest timeout
Idle read timeout of each call: how long to wait without receiving data. Default PT2M, must be positive. Mailchimp itself cuts requests off after 120 seconds.
Outputs
row object
First record
Populated when fetchType is FETCH_ONE.
rows array
Records
Populated when fetchType is FETCH.
size integer
Record count
Number of records read from Mailchimp.
total integer
Total count
Total number of matching records reported by Mailchimp (total_items), when available.
uri string
uriStored records URI
Populated when fetchType is STORE: an ION file in internal storage.
