Individual Contact List

Use this endpoint to retrieve (GET), update (PUT), or delete (DELETE) a contact list. To create a new contact list, use the POST method for the Contact List Collection.

Methods:

Click a method to view its documentation

GET PUT DELETE

DescriptionTOP

Privileges required: contacts:lists:read

GET a specific contact list (specified using the listId path parameter).

name	type	description
GET: https://api.constantcontact.com/v2/lists/{listId}
Test API
api_key	query	REQUIRED; The API key for the application
listId	path	ID of the ContactList to retrieve

Response CodesTOP

code	description
200	Request was successful
401	Authentication failure
404	List not found
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",
    "name": "Monthly Specials",
    "status": "ACTIVE",
    "created_date": "2013-03-11T20:37:28.000Z",
    "modified_date": "2013-03-11T20:41:42.000Z",
    "contact_count": 127
}