Skip to navigation
API ReferenceLists

List members info

Get information about members in a specific Mailchimp list.

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.

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.

email_typestringOptional
The email type.
statusenumOptional
The subscriber's status.
since_timestamp_optstringOptional

Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_timestamp_optstringOptional

Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_last_changedstringOptional

Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_last_changedstringOptional

Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

unique_email_idstringOptional
A unique identifier for the email address across all Mailchimp lists.
vip_onlybooleanOptional

A filter to return only the list's VIP members. Passing true will restrict results to VIP list members, passing false will return all list members.

interest_category_idstringOptional
The unique id for the interest category.
interest_idsstringOptional

Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories.

interest_matchenumOptional

Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. "any" will match a member with any of the interest supplied, "all" will only match members with every interest supplied, and "none" will match members without any of the interest supplied.

Allowed values:
sort_fieldenumOptional
Returns files sorted by the specified field.
Allowed values:
sort_direnumOptional
Determines the order direction for sorted results.
Allowed values:
since_last_campaignbooleanOptional

Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.

unsubscribed_sincestringOptional
Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.

Response

This endpoint returns an object.
list_idstringOptional
The list id.
memberslist of objectsOptional
An array of objects, each representing a specific list member.
total_itemsintegerOptionalRead-only
The total number of items matching the query regardless of pagination.