Skip to navigation
API ReferenceLists

Get lists info

Get information about all lists in the account.

Authentication

AuthorizationBearer

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

OR
AuthorizationBearer
Authorization using OAuth

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.

countintegerOptional<=1000Defaults to 10
The number of records to return. Default value is 10. Maximum value is 1000
offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

before_date_createdstringOptional

Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_date_createdstringOptional

Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_campaign_last_sentstringOptional

Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_campaign_last_sentstringOptional

Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

emailstringOptional
Restrict results to lists that include a specific subscriber's email address.
sort_fieldenumOptional
Returns files sorted by the specified field.
Allowed values:
sort_direnumOptional
Determines the order direction for sorted results.
Allowed values:
has_ecommerce_storebooleanOptional
Restrict results to lists that contain an active, connected, undeleted ecommerce store.
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.
listslist of objects
An array of objects, each representing a list.
constraintsobjectOptional
Do particular authorization constraints around this collection limit creation of new instances?
total_itemsintegerOptionalRead-only
The total number of items matching the query regardless of pagination.