MAmailchimp
lists

List members info

Get information about members in a specific Mailchimp list.

get/3.0/lists/{list_id}/members

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.

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.

email_typestring

The email type.

status'subscribed' | 'unsubscribed' | 'cleaned' | 'pending' | 'transactional' | 'archived'

The subscriber's status.

since_timestamp_optstring

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_optstring

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_changedstring

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_changedstring

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_idstring

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

vip_onlyboolean

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_idstring

The unique id for the interest category.

interest_idsstring

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_match'any' | 'all' | 'none'

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.

sort_field'timestamp_opt' | 'timestamp_signup' | 'last_changed'

Returns files sorted by the specified field.

sort_dir'ASC' | 'DESC'

Determines the order direction for sorted results.

since_last_campaignboolean

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

unsubscribed_sincestring

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

Response

list_idstring

The list id.

total_itemsinteger

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

Example response

{
  "members": [
    {
      "stats": {
        "ecommerce_data": {
          "currency_code": "USD"
        }
      }
    }
  ]
}

Changes

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