Our v3 API is now available! Learn more by visiting the v3 developer portal . Creating new v2 API keys is no longer supported.

Contact List Membership

Use the Contact List Membership endpoint to retrieve (GET) the contacts that are members of a contact list.

Methods:

Click a method to view its documentation

GET

Description TOP

Privileges required : contacts:lists:read

Retrieves a list of the contacts in the contact list specified using the listId path parameter. Use the modified_since query parameter to retrieve only contacts in the list that have been modified on or after the date/time specified; this is useful for syncing contact lists across applications.

Description TOP

Privileges required : contacts:lists:read

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

Description TOP

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.

GET: https://api.constantcontact.com/v2/lists/{listId}/contacts

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

limit

query

50

Specifies the number of results displayed per page of output, from 1 - 500, default = 50. See Paginated Output for more information on using limit .

listId

path

none

Specifies the ContactList to retrieve

modified_since

query

Use to retrieve only contacts in the list that were modified on or after the date/time specified in ISO-8601 format.

Response Codes TOP

code

description

200

Request was successful

401

Authentication failure

404

Contact list not found

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

Structure TOP

property

type (max length)

description

Example Response TOP

{
    "meta": {
        "pagination": {
            "next_link": "/v2/lists/1/contacts?next=c3RhcnRBdD0xMTYwJmxpbWl0PTI"
        }
    },
    "results":[
        {
        "id": "1",
        "status": "ACTIVE",
        "addresses": [
        {
            "line1": "123 Maple Street",
            "line2": "Suite 100",
            "city": "Boston",
            "address_type": "BUSINESS",
            "state_code":"MA",
            "country_code": "US",
            "postal_code": "02148",
            "sub_postal_code": ""
        }
    ],
     "notes": [
        {
            "id": "3",
            "note": "Approves all IC purchases",
            "created_date":"2013-03-11T17:20:17.383Z",
            "modified_date":"2013-03-11T17:20:17.383Z"
        }
      ],       
   "confirmed": false,
   "lists": [
        {
            "id": "1",
            "name": "Key Accounts"
         }
    ],
    "source": "API",
    "email_addresses": [
        {
            "status": "ACTIVE",
            "confirm_status": "CONFIRMED",
            "opt_in_source": "ACTION_BY_VISITOR",
            "opt_in_date": "2012-02-10T11:07:43.626Z",
            "opt_out_date": "2012-02-10T11:07:51.980Z",
            "email_address": "email@example.com"
        }
    ],
    "prefix_name": "Mr.",
    "first_name": "Pradeep",
    "middle_name": "",
    "last_name": "Patel",
    "job_title": "Purchasing Manager",
    "department_name": "Operations",
    "company_name": "My Company",
    "home_phone": "555-555-1212",
    "work_phone": "555-555-1213",
    "cell_phone": "555-555-1214",
    "custom_fields": [
        {
            "name": "CustomField1",
            "value": "Responsible budget > $2.5 million"
        }
    ],
    "insert_date": "2009-09-03T17:47:19.658Z",
    "last_update_date": "2013-02-25T15:32:24.000Z"
        }
   ]
}