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

DescriptionTOP

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.

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 CodesTOP

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

StructureTOP

property

type(max length)

description

+ addresses

array

Mail addresses for the contact. API currently supports a maximum of 2 addresses, 1 PERSONAL and 1 BUSINESS. It is possible to create up to 10 physical addresses using the product GUI. The API ignores any additional PERSONAL and BUSINESS addresses, and it ignores any other address_type.

cell_phone

string (50)

The contact's cell phone number

company_name

string (50)

The contact's company

confirmed

boolean

Confirmed = true if the contact has confirmed their email subscription, and it is false if they have not.

created_date

string

Date & time the contact was added, in ISO 8601 format

+ custom_fields

array

You can create up to 15 custom fields for a contact. The API currently only supports the custom field format described here. If the account uses the new contact management system, it is possible to create custom fields with varying formats. The API ignores custom fields not using the format below.

+ email_addresses

array

Array of contact's email addresses, Currently only one email address is supported for each contact. If the account uses the new contact management system, it is possible to create more than 1 email address per contact using the product GUI. The API ignores additional email addresses.

fax

string (50)

The contact's fax number

first_name

string (50)

The contact's first name

home_phone

string (50)

The contact's home phone number

id

string

Unique ID for the contact

job_title

string (50)

The contact's job title

last_name

string (50)

The contact's last name

+ lists

array

Array of the contact lists that the contact is a member of

modified_date

string

Date & time the contact was last updated, in ISO 8601 format; value is the same as created_date if contact has not been updated. Check here for a list of properties that, when changed or added, modify the modified_date value.

+ notes

array

A note associated with the contact.

prefix_name

string (4)

Salutation (Mr., Ms., Sir, Mrs., Dr., etc)

source

string (50)

Describes how the contact was added, from an application, web page, etc.

source_details

string (255)

Name of the application used to add contact, if added using the API

status

string

Contact status, valid values are:

  • ACTIVE: Contact is an active member of a contact list and can receive campaigns
  • UNCONFIRMED: Contact has not confirmed their email address after subscribing and cannot receive campaigns
  • OPTOUT: Contact has unsubscribed from the contact list and is on the Do Not Mail list; they cannot be manually added to any contactlist
  • REMOVED: Contact has been taken off all contactlists, and can be added to a contactlist
  • NON_SUBSCRIBER: someone who is not a contact, but has registered for one of the account's events
  • VISITOR: a person who has "liked" one of the account's social campaign pages
  • TEMP_HOLD - the account owner has temporarily stopped sending campaigns to subscriber. Learn more here.

work_phone

string (50)

The contact's Work phone number

Example ResponseTOP

{
    "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"
        }
   ]
}