Contact Lists

GET Lists Collection

Changed on

Use this method to return details about all contact lists for the account.

<div class="Msg"><p class="note-text">This method does not currently support filtering results using the contact list update date.</p></div>
get/contact_lists

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/contact_lists
  • 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

Query parameters

limitinteger

Use to specify the number of results displayed per page of output, from 1 - 500, default = 50.

include_countboolean

Set include_count to true to return the total number of contact lists that meet your selection criteria.

include_membership_count'all' | 'active'

Use to include the total number of contacts per list. Set to active, to count only active (mailable) contacts, or all to count all contacts.

namestring

Use to get details for a single list by entering the full name of the list.

status'all' | 'active' | 'deleted'

Use to get lists by status. Accepts comma-separated status values.

channel_type'email' | 'sms'

Use to return lists by channel type. The default value is email.

include_sms_membership_countboolean

Set to true to return the total number of SMS members in each list. Only applicable when channel_type is sms. Default is false.

Response

Request successful

lists_countinteger

The total number of contact lists.

Example response

{
  "lists": [
    {
      "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
    }
  ],
  "lists_count": 249,
  "_links": {
    "next": {
      "href": "/v3/activities/04fe9a97-a579-43c5-bb1a-58ed29bf0a6a"
    }
  }
}

Changes

  • 4b4a534c818dRevision changes
    • info

      added the new optional query request parameter channel_type

    • info

      added the new optional query request parameter include_sms_membership_count

  • 2483585c5d89Revision changes
    • info

      the endpoint scheme security api_key was removed from the API