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

  1. {
  2. "meta": {
  3. "pagination": {
  4. "next_link": "/v2/lists/1/contacts?next=c3RhcnRBdD0xMTYwJmxpbWl0PTI"
  5. }
  6. },
  7. "results":[
  8. {
  9. "id": "1",
  10. "status": "ACTIVE",
  11. "addresses": [
  12. {
  13. "line1": "123 Maple Street",
  14. "line2": "Suite 100",
  15. "city": "Boston",
  16. "address_type": "BUSINESS",
  17. "state_code":"MA",
  18. "country_code": "US",
  19. "postal_code": "02148",
  20. "sub_postal_code": ""
  21. }
  22. ],
  23. "notes": [
  24. {
  25. "id": "3",
  26. "note": "Approves all IC purchases",
  27. "created_date":"2013-03-11T17:20:17.383Z",
  28. "modified_date":"2013-03-11T17:20:17.383Z"
  29. }
  30. ],
  31. "confirmed": false,
  32. "lists": [
  33. {
  34. "id": "1",
  35. "name": "Key Accounts"
  36. }
  37. ],
  38. "source": "API",
  39. "email_addresses": [
  40. {
  41. "status": "ACTIVE",
  42. "confirm_status": "CONFIRMED",
  43. "opt_in_source": "ACTION_BY_VISITOR",
  44. "opt_in_date": "2012-02-10T11:07:43.626Z",
  45. "opt_out_date": "2012-02-10T11:07:51.980Z",
  46. "email_address": "email@example.com"
  47. }
  48. ],
  49. "prefix_name": "Mr.",
  50. "first_name": "Pradeep",
  51. "middle_name": "",
  52. "last_name": "Patel",
  53. "job_title": "Purchasing Manager",
  54. "department_name": "Operations",
  55. "company_name": "My Company",
  56. "home_phone": "555-555-1212",
  57. "work_phone": "555-555-1213",
  58. "cell_phone": "555-555-1214",
  59. "custom_fields": [
  60. {
  61. "name": "CustomField1",
  62. "value": "Responsible budget > $2.5 million"
  63. }
  64. ],
  65. "insert_date": "2009-09-03T17:47:19.658Z",
  66. "last_update_date": "2013-02-25T15:32:24.000Z"
  67. }
  68. ]
  69. }
  70.