MAmailchimp
search-members

Search members

Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.

get/3.0/search-members

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. Query should be a valid email, or a string representing a contact's first or last name.

list_idstring

The unique id for the list.

Response

Example response

{
  "exact_matches": {
    "members": [
      {
        "stats": {
          "ecommerce_data": {
            "currency_code": "USD"
          }
        }
      }
    ]
  },
  "full_search": {
    "members": [
      {
        "stats": {
          "ecommerce_data": {
            "currency_code": "USD"
          }
        }
      }
    ]
  }
}

Changes

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