EndPoint Get List Details
Name
get_list
Description
Get information about a specific campaign. [API reference]
Parameters
Parameter | Label | Required | Options | Description |
---|---|---|---|---|
Id | List Id | YES | The ID of the list for which data should be read. |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Raw | Description |
---|---|---|---|---|---|
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 |
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 Details using API Source
Mailchimp
Get List Details

Get List Details using API Destination
Mailchimp
Get List Details
