Make a POST request to the /activities/contact_exports endpoint to create a CSV export activity. After Constant Contact finishes processing the activity, use the results object in the response body to retrieve the CSV file.

You can choose to export all contacts in your account (default) or you can use one of the following mutually exclusive parameters to select which contacts to export:

• contact_ids: Specify up to 500 contact IDs.
• list_ids: Specify up to 50 contact list IDs.
• segment_id: Specify one segment ID.

In addition, include any of the following query parameters to refine your results:

• fields: By default, all contact related fields are exported. Use the fields array to only export specific fields. You must export email_address to successfully export email_optin_source, email_optin_date, email_optout_source, email_optout_date, or email_optout_reason.
• exclude: The contacts (contact_ids) to exclude from the export activity. Applicable with either no source parameter specified or with list_ids or new_subscriber as the source.
• status: Filter contact results by status; active, unsubscribed, or removed.

Step 1:Create an Export Activity

Use the JSON request body to define the contacts (rows in the CSV file) and the contact properties (columns in the CSV file) you want to export.

Request Body Schema

Example POST CSV Export Request

POST https://api.cc.email/v3/activities/contact_exports

User privileges: contacts:write

Authorization scopes: contact_data

This example request exports the email_address, first_name, last_name, and updated_at fields for the three contacts in the contact_ids array.

<?php

$request = new HttpRequest();
$request->setUrl('https://api.cc.email/v3/activities/contact_exports');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'Authorization' => 'Bearer {access_token}',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
));

$request->setBody(' { 
  "contact_ids": [
    "04fe9a97-a579-43c5-bb1a-58ed29bf0a6a",
    "af424130-f968-11e8-9c64-fa163e6b01c1",
    "d8061a00-eda7-11e8-ae8d-fa163e6b01c1"
  ],
  "fields": [
    "email_address", "first_name", "last_name", "updated_at"
  ],
  "status": "active"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

curl -X POST \
  https://api.cc.email/v3/activities/contact_exports \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -d ' { 
  "contact_ids": [
    "04fe9a97-a579-43c5-bb1a-58ed29bf0a6a",
    "af424130-f968-11e8-9c64-fa163e6b01c1",
    "d8061a00-eda7-11e8-ae8d-fa163e6b01c1"
  ],
  "fields": [
    "email_address", "first_name", "last_name", "updated_at"
  ],
  "status": "active"
}'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, " { \r\n  \"contact_ids\": [\r\n    \"04fe9a97-a579-43c5-bb1a-58ed29bf0a6a\",\r\n    \"af424130-f968-11e8-9c64-fa163e6b01c1\",\r\n    \"d8061a00-eda7-11e8-ae8d-fa163e6b01c1\"\r\n  ],\r\n  \"fields\": [\r\n    \"email_address\", \"first_name\", \"last_name\", \"updated_at\"\r\n  ],\r\n  \"status\": \"active\"\r\n}");
Request request = new Request.Builder()
  .url("https://api.cc.email/v3/activities/contact_exports")
  .post(body)
  .addHeader("Accept", "application/json")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {access_token}")
  .build();

Response response = client.newCall(request).execute();

Step 2:Retrieve the CSV File

After you successfully create a CSV export activity, the response body returns a _links object that contains a self link and a results link.

• Use the self object link to check the state of the activity and confirm that it is completed. For more information, see Get the Status of a Bulk Activity.
• Use the results object link to retrieve the CSV file.

POST CSV Export Example Response Body

{
    "activity_id": "118e461a-0c9e-11ea-b1f5-fa163e6b01c1",
    "state": "completed",
    "created_at": "2019-11-21T15:32:42-05:00",
    "updated_at": "2019-11-21T15:32:42-05:00",
    "percent_done": 100,
    "activity_errors": [],
    "status": {
        "items_total_count": 149,
        "items_completed_count": 149
    },
    "_links": {
        "self": {
            "href": "/v3/activities/118e461a-0c9e-11ea-b1f5-fa163e6b01c1"
        },
        "results": {
            "href": "/v3/contact_exports/118ceeaa-0c9e-11ea-b1f5-fa163e6b01c1"
        }
    }
}

After Constant Contact finishes processing the activity and it returns a completed state, use the link in the results object to make a GET request and retrieve the CSV file.

Example GET CSV Request

GET https://api.cc.email/v3/contact_exports/{file_export_id}

User privileges: contacts:write

Authorization scopes: contact_data

This example GET request retrieves a CSV file after a successful CSV export activity. The example response body uses the same rows and columns specified in the example POST CSV export activity.

<?php

$request = new HttpRequest();
$request->setUrl('https://api.cc.email/v3/contact_exports/{file_export_id}');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'Accept' => 'text/csv',
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {access_token}',
  'Cache-Control' => 'no-cache'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

curl -X GET \
  'https://api.cc.email/v3/contact_exports/{file_export_id}' \
  -H 'Accept: text/csv' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Cache-Control: no-cache'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.cc.email/v3/contact_exports/{file_export_id}")
  .get()
  .addHeader("Accept", "text/csv")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {access_token}")
  .addHeader("Cache-Control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

Get CSV Example Response Body

First name,Last name,Email address - other,Updated At
Dipali,Nipperdipper,ddipper@example.com,2018-11-29 15:10:15 -0500
Jake,Dodge,jdodge@jdogepancakes.com,2019-11-25T16:29:13.057 -0500
Jack,Smith,jacksbbq@example.com,2019-11-25T16:29:13.057 -0500

Try it!