Skip to navigation
API ReferenceCampaigns

List campaigns

Get all campaigns in an account.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countintegerOptional<=1000Defaults to 10
The number of records to return. Default value is 10. Maximum value is 1000
offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

typeenumOptional
The campaign type.
Allowed values:
statusenumOptional
The status of the campaign.
Allowed values:
before_send_timedatetimeOptional

Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_send_timedatetimeOptional

Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_create_timedatetimeOptional

Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_create_timedatetimeOptional

Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

list_idstringOptional
The unique id for the list.
folder_idstringOptional
The unique folder id.
member_idstringOptional

Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address.

sort_fieldenumOptional
Returns files sorted by the specified field.
Allowed values:
sort_direnumOptional
Determines the order direction for sorted results.
Allowed values:
include_resend_shortcut_eligibilitybooleanOptional

Return the resend_shortcut_eligibility field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered.

include_resend_shortcut_usagebooleanOptional

Return the resend_shortcut_usage field in the response. This includes information about campaigns related by a shortcut.

Response

This endpoint returns an object.
campaignslist of objectsOptional
An array of campaigns.
total_itemsintegerOptionalRead-only
The total number of items matching the query regardless of pagination.