GET a Collection of Email Campaigns
Changed onUse this method to list and get details about your email campaigns. By default, this method returns all email campaigns for the user account including deleted email campaigns. To get email campaigns within a date-range, use the after_date and before_date query parameters.
This endpoint does not return campaign activity details for each email campaign in the collection. To get email campaign activity details for a single email campaign, use the GET /emails/{campaign_id} endpoint."
<div class="Msg"><p class="note-text">This method does not currently support filtering results using the email campaign creation date.</p></div>Request
- Base URLhttps://api.cc.email/v3
- URLhttps://api.cc.email/v3/emails
- Auth
- OAuth 2Implicit: https://authz.constantcontact.com/oauth2/default/v1/authorizeScopes: campaign_data
- or OAuth 2Authorization code: https://authz.constantcontact.com/oauth2/default/v1/authorizeToken URL: https://authz.constantcontact.com/oauth2/default/v1/token scopes: campaign_data
Query parameters
Specifies the number of campaigns to display on each page of output that is returned (from return 1 - 500). The default returns 50 campaigns per page.
Use to return email campaigns with updated_at timestamps that are before a specific date and time (in ISO-8601 format). Use with the after_date query parameter to get email campaigns sent within a specific date range.
Use to return email campaigns with last updated_at timestamps that are after a specific date and time (in ISO-8601 format). Use with the before_date query parameter to get email campaigns sent within a specific date range.
Response
Request successful.
Example response
{
"campaigns": [
{
"campaign_id": "8987dc1a-48ef-433a-b836-7ca4f9aa3481",
"created_at": "2018-02-06T22:09:15.000Z",
"current_status": "Draft",
"name": "December Newsletter for Dog Lovers",
"type": "NEWSLETTER",
"type_code": 10,
"updated_at": "2018-06-27T10:28:09.000Z"
}
]
}Changes
- info
the endpoint scheme security
api_keywas removed from the API
- info
- info
added the new optional
queryrequest parameterafter_date - info
added the new optional
queryrequest parameterbefore_date
- info