MAmailchimp
lists

Get list info

Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.

get/3.0/lists/{list_id}

Request

Path parameters

list_idstring required

The unique ID for the list.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

include_total_contactsboolean

Deprecated. Return the total_contacts field in the stats response, which contains an approximate count of subscribed, unsubscribed, and transactional contacts. For a complete audience contact count, use the /audiences endpoint instead.

Response

beamer_addressstring

The list's Email Beamer address.

date_createdstring date-time

The date and time that this list was created in ISO 8601 format.

double_optinboolean

Whether or not to require the subscriber to confirm subscription via email.

email_type_optionboolean

Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup.

has_welcomeboolean

Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup.

idstring

A string that uniquely identifies this list.

list_ratinginteger

An auto-generated activity score for the list (0-5).

marketing_permissionsboolean

Whether or not the list has marketing permissions (eg. GDPR) enabled.

modulesstring[]

Any list-specific modules installed for this list.

namestring

The name of the list.

notify_on_subscribestring

The email address to send subscribe notifications to.

notify_on_unsubscribestring

The email address to send unsubscribe notifications to.

permission_reminderstring

The permission reminder for the list.

subscribe_url_longstring

The full version of this list's subscribe form (host will vary).

subscribe_url_shortstring

Our url shortened version of this list's subscribe form.

use_archive_barboolean

Whether campaigns for this list use the Archive Bar in archives by default.

visibility'pub' | 'prv'

Legacy - visibility settings are no longer used

web_idinteger

The ID used in the Mailchimp web application. View this list in your Mailchimp account at https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}.

Changes

No recorded changes to this operation across all 1 revision of this API.