Mailchimp Connector
Documentation
Version: 1
Documentation
Home » API Integration Hub » Mailchimp Connector » EndPoints » Get List Members

EndPoint Get List Members

Name

get_list_members

Description

Get information about members in a specific Mailchimp list. [API reference]

Parameters

Parameter Label Required Options Description
ListId List Id YES The ID of the list for which you like to perform this operation.
email_type Email Type NO
Option Value
html html
text text
The email type.
status Status NO
Option Value
subscribed subscribed
unsubscribed unsubscribed
cleaned cleaned
pending pending
transactional transactional
archived archived
The subscriber's status. Possible values: subscribed, unsubscribed, cleaned, pending, transactional, or archived.
since_timestamp_opt Since Timestamp Opt (Format: 2015-10-21T15:41:36) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
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_opt Before Timestamp Opt (Format: 2015-10-21T15:41:36) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
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_changed Since Last Changed (Format: 2015-10-21T15:41:36) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
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_changed Before Last Changed (Format: 2015-10-21T15:41:36) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
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_id Unique Email Id NO A unique identifier for the email address across all Mailchimp lists.
vip_only VIP Only NO
Option Value
true true
false false
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_id Interest Category Id NO The unique id for the interest category.
interest_ids Interest Ids NO 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 Interest Match NO 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. Possible values: 'any', 'all', or 'none'.
since_last_campaign Since Last Campaign NO
Option Value
true true
false false
Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.
unsubscribed_since Unsubscribed Since (Format: 2015-10-21T15:41:36) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_WSTR nvarchar(200) 200 False
ListId DT_WSTR nvarchar(200) 200 False
EmailAddress DT_WSTR nvarchar(200) 200 False
UniqueEmailId DT_WSTR nvarchar(200) 200 False
ContactId DT_WSTR nvarchar(200) 200 False
FullName DT_WSTR nvarchar(100) 100 False
WebId DT_I4 int False
EmailType DT_WSTR nvarchar(20) 20 False
Status DT_WSTR nvarchar(20) 20 False
ConsentsToOneToOneMessaging DT_BOOL bit False
FirstName DT_WSTR nvarchar(50) 50 False
LastName DT_WSTR nvarchar(50) 50 False
AddressLine1 DT_WSTR nvarchar(200) 200 False
AddressLine2 DT_WSTR nvarchar(200) 200 False
City DT_WSTR nvarchar(200) 200 False
State DT_WSTR nvarchar(100) 100 False
Zip DT_WSTR nvarchar(20) 20 False
Country DT_WSTR nvarchar(100) 100 False
Phone DT_WSTR nvarchar(50) 50 False
Birthday DT_WSTR nvarchar(50) 50 False
StatsAvgOpenRate DT_I4 int False
StatsAvgClickRate DT_I4 int False
IpSignup DT_WSTR nvarchar(200) 200 False
TimestampSignup DT_DBTIMESTAMP datetime False
IpOpt DT_WSTR nvarchar(200) 200 False
TimestampOpt DT_DBTIMESTAMP datetime False
MemberRating DT_I4 int False
LastChanged DT_DBTIMESTAMP datetime False
Language DT_WSTR nvarchar(100) 100 False
Vip DT_BOOL bit False
EmailClient DT_WSTR nvarchar(200) 200 False
Latitude DT_I4 int False
Longitude DT_I4 int False
LocationGmtOff DT_I4 int False
LocationDstOff DT_I4 int False
CountryCode DT_WSTR nvarchar(100) 100 False
TimeZone DT_WSTR nvarchar(100) 100 False
Region DT_WSTR nvarchar(100) 100 False
Source DT_WSTR nvarchar(100) 100 False
TagsCount DT_I4 int False
Tags DT_WSTR nvarchar(4000) 4000 False

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Mailchimp Connector in API Source component to read data or in API Destination component to read/write data:

Get List Members using API Source

Mailchimp
Get List Members
SSIS API Source - Read from table or endpoint

Get List Members using API Destination

Mailchimp
Get List Members
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Get list of members within a specific list/audience in your Mailchimp account 

SELECT * FROM get_list_members 
WITH (ListId='e246f7e24d')

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get list of members within a specific list/audience in your Mailchimp account 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_list_members 
WITH (ListId=''e246f7e24d'')';

EXEC (@MyQuery) AT [LINKED_SERVER_TO_MAILCHIMP_IN_DATA_GATEWAY];