Endpoint

Get Lists

Name

get_lists

Description

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

Related Tables

Lists

Parameters

Parameter

Label

Required

Options

Description

before_date_created

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

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

since_date_created

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

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

before_campaign_last_sent

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

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

since_campaign_last_sent

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

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

Includes email address

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

has_ecommerce_store

Contains active ecommerce store

Option	Value
true	true
false	false

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

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(100)`	100	`False`
WebId	`DT_I4`	`int`		`False`
Name	`DT_WSTR`	`nvarchar(100)`	100	`False`
Company	`DT_WSTR`	`nvarchar(500)`	500	`False`
Address1	`DT_WSTR`	`nvarchar(500)`	500	`False`
Address2	`DT_WSTR`	`nvarchar(500)`	500	`False`
City	`DT_WSTR`	`nvarchar(100)`	100	`False`
State	`DT_WSTR`	`nvarchar(100)`	100	`False`
Zip	`DT_WSTR`	`nvarchar(100)`	100	`False`
Country	`DT_WSTR`	`nvarchar(100)`	100	`False`
Phone	`DT_WSTR`	`nvarchar(100)`	100	`False`
PermissionReminder	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
UseArchiveBar	`DT_BOOL`	`bit`		`False`
CampaignDefaultFromName	`DT_WSTR`	`nvarchar(100)`	100	`False`
CampaignDefaultFromEmail	`DT_WSTR`	`nvarchar(500)`	500	`False`
CampaignDefaultSubject	`DT_WSTR`	`nvarchar(500)`	500	`False`
CampaignDefaultLanguage	`DT_WSTR`	`nvarchar(100)`	100	`False`
NotifyOnSubscribe	`DT_WSTR`	`nvarchar(500)`	500	`False`
NotifyOnUnsubscribe	`DT_WSTR`	`nvarchar(500)`	500	`False`
DateCreated	`DT_DBTIMESTAMP`	`datetime`		`False`
ListRating	`DT_I4`	`int`		`False`
EmailTypeOption	`DT_BOOL`	`bit`		`False`
SubscribeUrlShort	`DT_WSTR`	`nvarchar(512)`	512	`False`
SubscribeUrlLong	`DT_WSTR`	`nvarchar(1024)`	1024	`False`
BeamerAddress	`DT_WSTR`	`nvarchar(500)`	500	`False`
Visibility	`DT_WSTR`	`nvarchar(100)`	100	`False`
DoubleOptin	`DT_BOOL`	`bit`		`False`
HasWelcome	`DT_BOOL`	`bit`		`False`
MarketingPermissions	`DT_BOOL`	`bit`		`False`
Modules	`DT_WSTR`	`nvarchar(500)`	500	`False`
MemberCount	`DT_I4`	`int`		`False`
UnsubscribeCount	`DT_I4`	`int`		`False`
CleanedCount	`DT_I4`	`int`		`False`
MemberCountSinceSend	`DT_I4`	`int`		`False`
UnsubscribeCountSinceSend	`DT_I4`	`int`		`False`
CleanedCountSinceSend	`DT_I4`	`int`		`False`
CampaignCount	`DT_I4`	`int`		`False`
CampaignLastSent	`DT_WSTR`	`nvarchar(500)`	500	`False`
MergeFieldCount	`DT_I4`	`int`		`False`
AvgSubRate	`DT_I4`	`int`		`False`
AvgUnsubRate	`DT_I4`	`int`		`False`
TargetSubRate	`DT_I4`	`int`		`False`
OpenRate	`DT_I4`	`int`		`False`
ClickRate	`DT_I4`	`int`		`False`
LastSubDate	`DT_DBTIMESTAMP`	`datetime`		`False`
LastUnsubDate	`DT_DBTIMESTAMP`	`datetime`		`False`

If the column you are looking for is missing, consider customizing Mailchimp Connector.

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:

Read from Lists table using API Destination

This Endpoint belongs to Lists table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Mailchimp

Lists

Select

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get lists

SELECT * FROM get_lists

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 lists

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

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_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).