Contacts Collection | Constant Contact Developer

Contacts Collection Endpoint

Use this endpoint to retrieve (GET) contacts in the user's account, or to create (POST) a new contact.

Methods:

Click a method to view its documentation

GET POST

Description TOP

Privileges : contacts:read

Retrieves one or more contacts in the account, depending on the query parameters used:

All contacts in a user's account (no query parameters used)
A specific contact specified by the email query parameter

URL encode the email address, as with all query parameters values, to ensure proper system response.
The API is not able to return a contact by email address call if a contact's email address has been deleted in the product UI.

Only the contacts that have been modified on or after the date/time specified by the modified_since query parameter. This is useful for syncing contacts across applications.
Only the contacts with a status specified by the status query parameter.

name	type	default	description
GET: https://api.constantcontact.com/v2/contacts
Test API
api_key	query		REQUIRED; The API key for the application
email	query		Optional - specify the EXACT contact by email address to retrieve information for
include_contact_id	query	false	Boolean; `include_contact_id=true` returns the uuid formatted `contact_id` property, which is the list unique identifier in the V3 API. Useful for migrating V2 API integrations to the V3 API.
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` .
modified_since	query		Use to retrieve a list of only contacts that have been modified since the date and time specified in ISO-8601 format
status	query	ALL	Use to retrieve a list of contacts with a specific status; status values are: ALL - default, returns all contacts ACTIVE - Contact is an active member of a contact list UNCONFIRMED: Contact has not confirmed their email address yet and the account cannot send campaigns to them until they confirm OPTOUT: Contact has unsubscribed from a mailing list and is on the Do Not Mail list. See Using the Contacts API for information on opting contacts back in REMOVED: Contact has been removed from all contact lists by the account, but can be added back to a contact list

Response Codes TOP

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

Structure TOP

property	type (max length)	description

Example Response TOP


{
    "meta": {
        "pagination": {
            "next_link": "/v2/contacts?next=c3RhcnRBdD0zJmxpbWl0PTI"
        }
    },
    "results": [
        {
        "id": "196",
        "contact_id": "12345678-1234-1234-1234-123456789012",
        "status": "ACTIVE",
        "fax": "318-978-7575",
        "addresses": [
            {
                "id":"2",
                "line1": "47 Shawmut Ave.",
                "line2": "Suite 404",
                "city": "Boston",
                "address_type": "BUSINESS",
                "state":"Massachusetts",
                "state_code": "MA",
                "country_code": "us",
                "postal_code": "02158",
                "sub_postal_code": ""
            }
        ],
        "notes": [],
        "confirmed": false,
        "lists": [
            {
                "id": "1",
                "status": "ACTIVE"
            }
        ],
        "source": "API",
        "email_addresses": [
            {
                "id":"1",
                "status": "ACTIVE",
                "confirm_status": "NO_CONFIRMATION_REQUIRED",
                "opt_in_source": "ACTION_BY_VISITOR",
                "opt_in_date": "2013-01-23T13:48:44.108Z",
                "opt_out_date": "1969-12-31T19:00:00.000Z",
                "email_address": "rmartone@systems.com"
            }
        ],
        "prefix_name": "Mr.",
        "first_name": "Ronald",
        "last_name": "Martone",
        "job_title": "Systems Analyst 3",
        "company_name": "System Optimzations",
        "home_phone": "617-555-1212",
        "work_phone": "318-978-8896",
        "cell_phone": "448-989-3182",
        "custom_fields": [],
        "source_details": "New Contact Signup App"
		}
]
}