Retrieve all lists

📘

Returning results default to 20

The number of lists returned defaults to 20, and can be changed with a limit path parameter.

{ "lists": [ { "stringid": "email-subscription", "userid": "1", "name": "Email Subscription", "cdate": "2018-08-06T16:30:41-05:00", "p_use_tracking": "1", "p_use_analytics_read": "0", "p_use_analytics_link": "0", "p_use_twitter": "0", "p_use_facebook": "0", "p_embed_image": "1", "p_use_captcha": "1", "send_last_broadcast": "0", "private": "0", "analytics_domains": null, "analytics_source": "", "analytics_ua": "", "twitter_token": "", "twitter_token_secret": "", "facebook_session": null, "carboncopy": null, "subscription_notify": null, "unsubscription_notify": null, "require_name": "0", "get_unsubscribe_reason": "0", "to_name": "Subscriber", "optinoptout": "1", "sender_name": "", "sender_addr1": "", "sender_addr2": "", "sender_city": "", "sender_state": "", "sender_zip": "", "sender_country": "", "sender_phone": "", "sender_url": "http://www.ilankreimont.com", "sender_reminder": "You signed up for my mailing list.", "fulladdress": "", "optinmessageid": "0", "optoutconf": "0", "deletestamp": null, "udate": null, "links": { "contactGoalLists": "https://:account.api-us1.com/api/3/lists/1/contactGoalLists", "user": "https://:account.api-us1.com/api/3/lists/1/user", "addressLists": "https://:account.api-us1.com/api/3/lists/1/addressLists" }, "id": "1", "user": "1" }, { "stringid": "robert-list", "userid": "1", "name": "Robert List", "cdate": "2018-09-07T08:56:49-05:00", "p_use_tracking": "1", "p_use_analytics_read": "0", "p_use_analytics_link": "0", "p_use_twitter": "0", "p_use_facebook": "0", "p_embed_image": "1", "p_use_captcha": "1", "send_last_broadcast": "0", "private": "0", "analytics_domains": null, "analytics_source": "", "analytics_ua": "", "twitter_token": "", "twitter_token_secret": "", "facebook_session": null, "carboncopy": null, "subscription_notify": null, "unsubscription_notify": null, "require_name": "0", "get_unsubscribe_reason": "0", "to_name": "Subscriber", "optinoptout": "1", "sender_name": "", "sender_addr1": "", "sender_addr2": "", "sender_city": "", "sender_state": "", "sender_zip": "", "sender_country": "", "sender_phone": "", "sender_url": "http://www.activecampaign.com", "sender_reminder": "Test", "fulladdress": "", "optinmessageid": "0", "optoutconf": "0", "deletestamp": null, "udate": null, "links": { "contactGoalLists": "https://:account.api-us1.com/api/3/lists/2/contactGoalLists", "user": "https://:account.api-us1.com/api/3/lists/2/user", "addressLists": "https://:account.api-us1.com/api/3/lists/2/addressLists" }, "id": "2", "user": "1" } ], "meta": { "total": "2" } }

📘

How to use filters and operators

Incorrect:
filter[name][<operator>]=eq

Correct:
filter[name][eq]={value}

Example: to return lists that start with the letter "R", the correct filter to apply is:
?filters[name][starts_with]=R

Supported Operators:
eq, neq, lt, lte, gt, gte, contains, starts_with

Query Params
string

Filter by the name of the list

int32

Limit the number of returned results

string

Filters lists by list name according to the operator specified. (See supported operators below)

string

Orders filtered results by weight, ascending order, or descending order. If weight is used, exact matches are returned first, followed by matches starting with what was filtered by, followed by the rest of the results.

Responses

Language
Credentials
URL
Choose an example:
application/json
text/plain