Reference

Endpoint Get Lists

Name

get_lists

Description

Get information about all lists in the account. [API reference]

Related Tables

Lists

Parameters

Parameter Required Options
Name: before_date_created

Label: Created before (Format: 2015-10-21T15:41:36)

Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
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
Name: since_date_created

Label: Created after (Format: 2015-10-21T15:41:36)

Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
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
Name: before_campaign_last_sent

Label: Created before last campaign send date (Format: 2015-10-21T15:41:36)

Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
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
Name: since_campaign_last_sent

Label: Created after last campaign send date (Format: 2015-10-21T15:41:36)

Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
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
Name: email

Label: Includes email address

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

Label: Contains active ecommerce store

Restrict results to lists that contain an active, connected, undeleted ecommerce store.
Option Value
true true
false false

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(100) 100
WebId DT_I4 int
Name DT_WSTR nvarchar(100) 100
Company DT_WSTR nvarchar(500) 500
Address1 DT_WSTR nvarchar(500) 500
Address2 DT_WSTR nvarchar(500) 500
City DT_WSTR nvarchar(100) 100
State DT_WSTR nvarchar(100) 100
Zip DT_WSTR nvarchar(100) 100
Country DT_WSTR nvarchar(100) 100
Phone DT_WSTR nvarchar(100) 100
PermissionReminder DT_WSTR nvarchar(4000) 4000
UseArchiveBar DT_BOOL bit
CampaignDefaultFromName DT_WSTR nvarchar(100) 100
CampaignDefaultFromEmail DT_WSTR nvarchar(500) 500
CampaignDefaultSubject DT_WSTR nvarchar(500) 500
CampaignDefaultLanguage DT_WSTR nvarchar(100) 100
NotifyOnSubscribe DT_WSTR nvarchar(500) 500
NotifyOnUnsubscribe DT_WSTR nvarchar(500) 500
DateCreated DT_DBTIMESTAMP datetime
ListRating DT_I4 int
EmailTypeOption DT_BOOL bit
SubscribeUrlShort DT_WSTR nvarchar(512) 512
SubscribeUrlLong DT_WSTR nvarchar(1024) 1024
BeamerAddress DT_WSTR nvarchar(500) 500
Visibility DT_WSTR nvarchar(100) 100
DoubleOptin DT_BOOL bit
HasWelcome DT_BOOL bit
MarketingPermissions DT_BOOL bit
Modules DT_WSTR nvarchar(500) 500
MemberCount DT_I4 int
UnsubscribeCount DT_I4 int
CleanedCount DT_I4 int
MemberCountSinceSend DT_I4 int
UnsubscribeCountSinceSend DT_I4 int
CleanedCountSinceSend DT_I4 int
CampaignCount DT_I4 int
CampaignLastSent DT_WSTR nvarchar(500) 500
MergeFieldCount DT_I4 int
AvgSubRate DT_I4 int
AvgUnsubRate DT_I4 int
TargetSubRate DT_I4 int
OpenRate DT_I4 int
ClickRate DT_I4 int
LastSubDate DT_DBTIMESTAMP datetime
LastUnsubDate DT_DBTIMESTAMP datetime
If the column you are looking for is missing, consider customizing Mailchimp Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Lists table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Mailchimp
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
Mailchimp
Lists
Optional Parameters
Created before (Format: 2015-10-21T15:41:36)
Created after (Format: 2015-10-21T15:41:36)
Created before last campaign send date (Format: 2015-10-21T15:41:36)
Created after last campaign send date (Format: 2015-10-21T15:41:36)
Includes email address
Contains active ecommerce store
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Lists table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get lists:

API Destination - Mailchimp
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
Mailchimp
Lists
Select
Optional Parameters
Created before (Format: 2015-10-21T15:41:36)
Created after (Format: 2015-10-21T15:41:36)
Created before last campaign send date (Format: 2015-10-21T15:41:36)
Created after last campaign send date (Format: 2015-10-21T15:41:36)
Includes email address
Contains active ecommerce store
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get list of lists/audiences in your Mailchimp account 

SELECT * FROM Lists

Get specific columns in list of lists/audiences in your Mailchimp account 

SELECT Id, WebId, Name, Company, Address1, Address2, City, State, Zip, Country, Phone, PermissionReminder, UseArchiveBar, CampaignDefaultFromName, CampaignDefaultFromEmail, CampaignDefaultSubject, CampaignDefaultLanguage, NotifyOnSubscribe, NotifyOnUnsubscribe, DateCreated, ListRating, EmailTypeOption, SubscribeUrlShort, SubscribeUrlLong, BeamerAddress, Visibility, DoubleOptin, HasWelcome, MarketingPermissions, Modules, MemberCount, UnsubscribeCount, CleanedCount, MemberCountSinceSend, UnsubscribeCountSinceSend, CleanedCountSinceSend, CampaignCount, CampaignLastSent, MergeFieldCount, AvgSubRate, AvgUnsubRate, TargetSubRate, OpenRate, ClickRate, LastSubDate, LastUnsubDate 
FROM Lists

get_lists endpoint belongs to Lists table(s), and can therefore be used via those table(s).

SQL Server

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

Get list of lists/audiences in your Mailchimp account 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Lists';

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];

Get specific columns in list of lists/audiences in your Mailchimp account 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT Id, WebId, Name, Company, Address1, Address2, City, State, Zip, Country, Phone, PermissionReminder, UseArchiveBar, CampaignDefaultFromName, CampaignDefaultFromEmail, CampaignDefaultSubject, CampaignDefaultLanguage, NotifyOnSubscribe, NotifyOnUnsubscribe, DateCreated, ListRating, EmailTypeOption, SubscribeUrlShort, SubscribeUrlLong, BeamerAddress, Visibility, DoubleOptin, HasWelcome, MarketingPermissions, Modules, MemberCount, UnsubscribeCount, CleanedCount, MemberCountSinceSend, UnsubscribeCountSinceSend, CleanedCountSinceSend, CampaignCount, CampaignLastSent, MergeFieldCount, AvgSubRate, AvgUnsubRate, TargetSubRate, OpenRate, ClickRate, LastSubDate, LastUnsubDate 
FROM Lists';

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];

get_lists endpoint belongs to Lists table(s), and can therefore be used via those table(s).