Contact Lists

GET a List

Changed on

Use this method to get details about a specific contact list (list_id).

get/contact_lists/{list_id}

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/contact_lists/{list_id}
  • Auth
    • OAuth 2
      Implicit: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Scopes: contact_data
    • or OAuth 2
      Authorization code: https://authz.constantcontact.com/oauth2/default/v1/authorize
      Token URL: https://authz.constantcontact.com/oauth2/default/v1/token scopes: contact_data

Path parameters

list_idstring uuid required

The system generated ID that uniquely identifies a contact list.

Query parameters

include_membership_count'all' | 'active'

Returns the total number of contacts per list that meet your selection criteria. Set the include_membership_count to active, to count only active contacts, or all to include all contacts in the count.

Response

Request successful

list_idstring uuid required

Unique ID for the contact list

namestring required

The name given to the contact list

descriptionstring

Text describing the list.

favoriteboolean

Identifies whether or not the account has favorited the contact list.

created_atstring date-time

System generated date and time that the resource was created, in ISO-8601 format.

updated_atstring date-time

Date and time that the list was last updated, in ISO-8601 format. System generated.

deleted_atstring date-time

If the list was deleted, this property shows the date and time it was deleted, in ISO-8601 format. System generated.

membership_countinteger

The total number of contacts that are members in a list. Does not apply to segment type lists.

Example response

{
  "list_id": "06526938-56dd-11e9-932a-fa163ea075fa",
  "name": "Multiple purchases",
  "description": "List of repeat customers.",
  "created_at": "2016-01-23T13:48:44.108Z",
  "updated_at": "2016-03-03T10:56:29-05:00",
  "deleted_at": "2016-03-03T10:56:29-05:00",
  "membership_count": 327
}

Changes