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
Description TOP
Retrieve a specific partner webhook topic by specifying the
topicId
path parameter. See the available topic ID's
here
.
Description TOP
Privileges required : campaign:read
Retrieves the email campaign message specified by the
campaignId
path parameter. The
tracking_summary data
is current as of the last scheduled update, unless you set
updateSummary
=true to return updated data.
NOTE: Details of a deleted campaign cannot be retrieved. If a call is made to GET a deleted campaign by its ID, the call will fail and return a 404 Not Found response. You can login to the account to restore the campaign and then retrieve its details.
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.
Description TOP
Privileges required : mylibrary:folder:read
Retrieve a specific MyLibrary folder using the
folderId
path parameter.
Description TOP
Privileges required : mylibrary:file:read
Retrieve a MyLibrary file using the
fileId
path parameter.
Description TOP
Privileges required : campaign:read
Retrieve an event item by using the
eventId
and
itemId
path parameters to specify the event and item.
Description TOP
Privileges required : campaign:read
Get a specific event object (specified by the
event_id
path parameter). Properties with a null value are not returned in the JSON response.
Description TOP
Privileges required : campaign:read
Retrieve detailed information about a specific registrant (specified by
registrantId
) for an event (specified by
eventId
).
|
GET: https://api.constantcontact.com/v2/lists/{listId} |
|||
|
name |
type |
default |
description |
|---|---|---|---|
|
api_key |
query |
|
REQUIRED; The API key for the application |
|
listId |
path |
|
ID of the ContactList to retrieve |
Response Codes TOP
|
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 |
Structure TOP
|
property |
type (max length) |
description |
|---|
Example Response TOP
- {
- "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
- }