MAmailchimp
campaigns

List campaigns

Get all campaigns in an account.

get/3.0/campaigns

Request

Query parameters

fieldsstring[]

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

exclude_fieldsstring[]

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

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

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

type'regular' | 'plaintext' | 'absplit' | 'rss' | 'variate'

The campaign type.

status'save' | 'paused' | 'schedule' | 'sending' | 'sent'

The status of the campaign.

before_send_timestring date-time

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

since_send_timestring date-time

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

before_create_timestring date-time

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

since_create_timestring date-time

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

list_idstring

The unique id for the list.

folder_idstring

The unique folder id.

member_idstring

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_field'create_time' | 'send_time'

Returns files sorted by the specified field.

sort_dir'ASC' | 'DESC'

Determines the order direction for sorted results.

include_resend_shortcut_eligibilityboolean

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_usageboolean

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

Response

total_itemsinteger

The total number of items matching the query regardless of pagination.

Example response

{
  "campaigns": [
    {
      "recipients": {
        "segment_opts": {
          "conditions": [
            {
              "field": "aim",
              "op": "open",
              "value": "any"
            }
          ],
          "prebuilt_segment_id": "subscribers-female"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.