EndPoint Get Lists
Name
get_lists
Description
Get information about all lists in the account.
[API Help]
Parameters
Parameter |
Label |
Required |
Options |
Description |
before_date_created |
Created before (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 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) |
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 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) |
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 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) |
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 lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
|
email |
Includes email address |
NO |
|
Restrict results to lists that include a specific subscriber's email address.
|
has_ecommerce_store |
Contains active ecommerce store |
NO |
Option |
Value |
true |
true |
false |
false |
|
Restrict results to lists that contain an active, connected, undeleted ecommerce store.
|
Output Columns
Label |
DataType |
Length |
Raw |
Description |
Id |
DT_WSTR |
100 |
False |
|
WebId |
DT_I4 |
0 |
False |
|
Name |
DT_WSTR |
100 |
False |
|
Company |
DT_WSTR |
500 |
False |
|
Address1 |
DT_WSTR |
500 |
False |
|
Address2 |
DT_WSTR |
500 |
False |
|
City |
DT_WSTR |
100 |
False |
|
State |
DT_WSTR |
100 |
False |
|
Zip |
DT_WSTR |
100 |
False |
|
Country |
DT_WSTR |
100 |
False |
|
Phone |
DT_WSTR |
100 |
False |
|
PermissionReminder |
DT_WSTR |
4000 |
False |
|
UseArchiveBar |
DT_BOOL |
0 |
False |
|
CampaignDefaultFromName |
DT_WSTR |
100 |
False |
|
CampaignDefaultFromEmail |
DT_WSTR |
500 |
False |
|
CampaignDefaultSubject |
DT_WSTR |
500 |
False |
|
CampaignDefaultLanguage |
DT_WSTR |
100 |
False |
|
NotifyOnSubscribe |
DT_WSTR |
500 |
False |
|
NotifyOnUnsubscribe |
DT_WSTR |
500 |
False |
|
DateCreated |
DT_DBTIMESTAMP |
0 |
False |
|
ListRating |
DT_I4 |
0 |
False |
|
EmailTypeOption |
DT_BOOL |
0 |
False |
|
SubscribeUrlShort |
DT_WSTR |
512 |
False |
|
SubscribeUrlLong |
DT_WSTR |
1024 |
False |
|
BeamerAddress |
DT_WSTR |
500 |
False |
|
Visibility |
DT_WSTR |
100 |
False |
|
DoubleOptin |
DT_BOOL |
0 |
False |
|
HasWelcome |
DT_BOOL |
0 |
False |
|
MarketingPermissions |
DT_BOOL |
0 |
False |
|
Modules |
DT_WSTR |
500 |
False |
|
MemberCount |
DT_I4 |
0 |
False |
|
UnsubscribeCount |
DT_I4 |
0 |
False |
|
CleanedCount |
DT_I4 |
0 |
False |
|
MemberCountSinceSend |
DT_I4 |
0 |
False |
|
UnsubscribeCountSinceSend |
DT_I4 |
0 |
False |
|
CleanedCountSinceSend |
DT_I4 |
0 |
False |
|
CampaignCount |
DT_I4 |
0 |
False |
|
CampaignLastSent |
DT_WSTR |
500 |
False |
|
MergeFieldCount |
DT_I4 |
0 |
False |
|
AvgSubRate |
DT_I4 |
0 |
False |
|
AvgUnsubRate |
DT_I4 |
0 |
False |
|
TargetSubRate |
DT_I4 |
0 |
False |
|
OpenRate |
DT_I4 |
0 |
False |
|
ClickRate |
DT_I4 |
0 |
False |
|
LastSubDate |
DT_DBTIMESTAMP |
0 |
False |
|
LastUnsubDate |
DT_DBTIMESTAMP |
0 |
False |
|
Input Columns
Label |
DataType |
Length |
Raw |
Description |
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |