Contact List Collection

Use this endpoint to retrieve (GET) a collection of existing contact lists, or create (POST) a new contact list. An account can have a maximum of 1000 lists.

Methods:

Click a method to view its documentation

GET POST

DescriptionTOP

Privileges required: contacts:lists:read

Retrieves a list of the contact lists in the user's account. Use the modified_since query parameter to retrieve only contacts lists that have been modified on or after the date/time specified; this is useful for identifying and synching lists that have changed between applications.

name	type	default	description
GET: https://api.constantcontact.com/v2/lists
Test API
api_key	query		REQUIRED; The API key for the application
include_list_id	query	false	Boolean; `include_list_id=true` returns the uuid formatted `list_id` property, which is the list unique identifier in the V3 API. Useful for migrating V2 API integrations to the V3 API.
modified_since	query		Use this parameter to retrieve only the contact lists that have been modified on or after the date/time specified in ISO-8601 format.

Response CodesTOP

code	description
200	Request was successful
401	Authentication failure
404	ContactList not found for specified ID
406	Unsupported Accept Header value, must be application/json
500	Internal server error occurred

StructureTOP

property	type(max length)	description
contact_count	integer	The number of contacts in the list
created_date	string	Time stamp indicating when the contact list was created, in ISO-8601 format
id	string	Unique ID for each contact list
list_id	string	The uuid formatted unique identifier used to identify the list in the V3 API. Useful for migrating V2 API integrations to the V3 API.
modified_date	string	Time stamp indicating when the contact list was last modified, in ISO-8601 format
name	string (255)	Contact list name
status	string	The contact list status, valid values are: ACTIVE - the list is visible to contacts to join, and visible to Constant Contact users HIDDEN - list is not visible to contacts, but it is visible to Constant Contact users

Example ResponseTOP

[
    {
        "id": "1",
        "list_id":"12345678-1234-1234-1234-123456789012",
        "name": "General Interest",
        "status": "ACTIVE",
        "created_date": "2013-03-11T20:37:28.000Z",
        "modified_date": "2013-03-11T20:41:42.000Z",        
        "contact_count": 143
    },
    {
        "id": "2",
        "list_id":"12345678-1234-1234-1234-123456789012",
        "name": "Great News!",
        "status": "ACTIVE",
        "created_date": "2012-12-19T21:33:22.000Z",
        "modified_date": "2013-02-01T17:54:43.000Z",        
        "contact_count": 53
    },
    {
        "id": "3",
        "list_id":"12345678-1234-1234-1234-123456789012",
        "name": "Monthly Specials!",
        "status": "ACTIVE",
        "created_date": "2012-12-19T21:33:50.000Z",
        "modified_date": "2013-02-01T17:54:43.000Z",
        "contact_count": 375
    },
    {
        "id": "4",
        "list_id":"12345678-1234-1234-1234-123456789012",
        "name": "Tips, Tricks, & Fun!",
        "status": "HIDDEN",
        "created_date": "2012-12-19T21:33:50.000Z",
        "modified_date": "2013-02-01T17:54:43.000Z",
        "contact_count": 2
    }
    
]