Skip to navigation
API ReferenceLists

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.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

list_idstringRequired
The unique ID for the list.

Query parameters

fieldslist of stringsOptional

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

exclude_fieldslist of stringsOptional

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

include_total_contactsbooleanOptionalDeprecated

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

This endpoint returns an object.
beamer_addressstringOptionalRead-only

The list's Email Beamer address.

campaign_defaultsobjectOptional

Default values for campaigns created for this list.

contactobjectOptional

Contact information displayed in campaign footers to comply with international spam laws.

date_createddatetimeOptionalRead-only
The date and time that this list was created in ISO 8601 format.
double_optinbooleanOptionalDefaults to false
Whether or not to require the subscriber to confirm subscription via email.
email_type_optionbooleanOptional

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_welcomebooleanOptionalDefaults to false

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

idstringOptionalRead-only
A string that uniquely identifies this list.
list_ratingintegerOptionalRead-only

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

marketing_permissionsbooleanOptionalDefaults to false

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

moduleslist of stringsOptionalRead-only

Any list-specific modules installed for this list.

namestringOptional
The name of the list.
notify_on_subscribestringOptionalDefaults to false

The email address to send subscribe notifications to.

notify_on_unsubscribestringOptionalDefaults to false

The email address to send unsubscribe notifications to.

permission_reminderstringOptional

The permission reminder for the list.

statsobjectOptionalRead-only
Stats for the list. Many of these are cached for at least five minutes.
subscribe_url_longstringOptionalRead-only

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

subscribe_url_shortstringOptionalRead-only

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

use_archive_barbooleanOptionalDefaults to false

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

visibilityenumOptional

Legacy - visibility settings are no longer used

Allowed values:
web_idintegerOptionalRead-only

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}.