MAmailchimp
search-campaigns

Search campaigns

Search all campaigns for the specified query terms.

get/3.0/search-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.

querystring required

The search query used to filter results.

Response

total_itemsinteger

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

Example response

{
  "results": [
    {
      "campaign": {
        "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.