Search members

GET

https://api.mailchimp.com/3.0/search-members

GET

/3.0/search-members

curl -G https://api.mailchimp.com/3.0/search-members \
     -H "Authorization: Bearer <token>" \
     -d query=query

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "exact_matches": {
    "members": [
      {
        "_links": [
          {
            "href": "string",
            "method": "GET",
            "rel": "string",
            "schema": "string",
            "targetSchema": "string"
          }
        ],
        "consents_to_one_to_one_messaging": true,
        "contact_id": "string",
        "email_address": "string",
        "email_client": "string",
        "email_type": null,
        "id": "string",
        "interests": {},
        "ip_opt": "string",
        "ip_signup": "string",
        "language": "string",
        "last_changed": "2024-01-15T09:30:00Z",
        "last_note": {
          "created_at": "2024-01-15T09:30:00Z",
          "created_by": "string",
          "note": "string",
          "note_id": 1
        },
        "list_id": "string",
        "location": {
          "country_code": "string",
          "dstoff": 1,
          "gmtoff": 1,
          "latitude": 1.1,
          "longitude": 1.1,
          "region": "string",
          "timezone": "string"
        },
        "marketing_permissions": [
          {
            "enabled": true,
            "marketing_permission_id": "string",
            "text": "string"
          }
        ],
        "member_rating": 1,
        "merge_fields": {},
        "sms_phone_number": "string",
        "sms_subscription_last_updated": "string",
        "sms_subscription_status": "subscribed",
        "source": "string",
        "stats": {
          "avg_click_rate": 1.1,
          "avg_open_rate": 1.1,
          "ecommerce_data": {
            "currency_code": "USD",
            "number_of_orders": 1.1,
            "total_revenue": 1.1
          }
        },
        "status": "subscribed",
        "tags": [
          {
            "id": 1,
            "name": "string"
          }
        ],
        "tags_count": 1,
        "timestamp_opt": "2024-01-15T09:30:00Z",
        "timestamp_signup": "2024-01-15T09:30:00Z",
        "unique_email_id": "string",
        "unsubscribe_reason": "string",
        "vip": true,
        "web_id": 1
      }
    ],
    "total_items": 1
  },
  "full_search": {
    "members": [
      {
        "_links": [
          {
            "href": "string",
            "method": "GET",
            "rel": "string",
            "schema": "string",
            "targetSchema": "string"
          }
        ],
        "consents_to_one_to_one_messaging": true,
        "contact_id": "string",
        "email_address": "string",
        "email_client": "string",
        "email_type": null,
        "id": "string",
        "interests": {},
        "ip_opt": "string",
        "ip_signup": "string",
        "language": "string",
        "last_changed": "2024-01-15T09:30:00Z",
        "last_note": {
          "created_at": "2024-01-15T09:30:00Z",
          "created_by": "string",
          "note": "string",
          "note_id": 1
        },
        "list_id": "string",
        "location": {
          "country_code": "string",
          "dstoff": 1,
          "gmtoff": 1,
          "latitude": 1.1,
          "longitude": 1.1,
          "region": "string",
          "timezone": "string"
        },
        "marketing_permissions": [
          {
            "enabled": true,
            "marketing_permission_id": "string",
            "text": "string"
          }
        ],
        "member_rating": 1,
        "merge_fields": {},
        "sms_phone_number": "string",
        "sms_subscription_last_updated": "string",
        "sms_subscription_status": "subscribed",
        "source": "string",
        "stats": {
          "avg_click_rate": 1.1,
          "avg_open_rate": 1.1,
          "ecommerce_data": {
            "currency_code": "USD",
            "number_of_orders": 1.1,
            "total_revenue": 1.1
          }
        },
        "status": "subscribed",
        "tags": [
          {
            "id": 1,
            "name": "string"
          }
        ],
        "tags_count": 1,
        "timestamp_opt": "2024-01-15T09:30:00Z",
        "timestamp_signup": "2024-01-15T09:30:00Z",
        "unique_email_id": "string",
        "unsubscribe_reason": "string",
        "vip": true,
        "web_id": 1
      }
    ],
    "total_items": 1
  }
}

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.

Authentication

AuthorizationBearer

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

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.

querystringRequired

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_idstringOptional

The unique id for the list.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

exact_matchesobjectOptional

Exact matches of the provided search query.

full_searchobjectOptional

Partial matches of the provided search query.