MAmailchimp
lists

Get lists info

Get information about all lists in the account.

get/3.0/lists

Request

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.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

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

before_date_createdstring

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

since_date_createdstring

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

before_campaign_last_sentstring

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_sentstring

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

emailstring

Restrict results to lists that include a specific subscriber's email address.

sort_field'date_created'

Returns files sorted by the specified field.

sort_dir'ASC' | 'DESC'

Determines the order direction for sorted results.

has_ecommerce_storeboolean

Restrict results to lists that contain an active, connected, undeleted ecommerce store.

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

total_itemsinteger

The total number of items matching the query regardless of pagination.

Changes

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